fancy_gym/docs/source/conf.py

58 lines
1.4 KiB
Python
Raw Normal View History

2023-12-05 18:13:20 +01:00
# This conf.py is in large parts inspired by the oen used by stable-baselines 3
import toml
2023-12-05 18:13:20 +01:00
import datetime
2023-12-05 15:47:17 +01:00
project = 'Fancy Gym'
2023-12-05 18:13:20 +01:00
author = 'Fabian Otto, Onur Celik, Dominik Roth, Hongyi Zhou'
copyright = f'2020-{datetime.date.today().year}, {author}'
2023-12-05 15:47:17 +01:00
pyproject_content = toml.load("../../pyproject.toml")
proj_version = pyproject_content["project"]["version"]
release = proj_version # The full version, including alpha/beta/rc tags
version = proj_version # The short X.Y version
2023-12-05 15:47:17 +01:00
extensions = [
'myst_parser',
'sphinx.ext.duration',
'sphinx.ext.doctest',
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
2023-12-05 18:13:20 +01:00
# 'sphinx.ext.intersphinx',
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
2023-12-05 15:47:17 +01:00
]
autosummary_generate = True
intersphinx_mapping = {
'python': ('https://docs.python.org/3/', None),
'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
}
intersphinx_disabled_domains = ['std']
2023-12-05 18:13:20 +01:00
language = "en"
pygments_style = "sphinx"
2023-12-05 15:47:17 +01:00
templates_path = ['_templates']
exclude_patterns = ['build', 'Thumbs.db', '.DS_Store']
html_theme = 'sphinx_rtd_theme'
2023-12-05 18:13:20 +01:00
html_logo = "_static/imgs/icon.svg"
2023-12-13 15:52:44 +01:00
html_favicon = "_static/imgs/icon.svg"
2023-12-05 15:47:17 +01:00
epub_show_urls = 'footnote'
html_static_path = ['_static']
2023-12-05 18:13:20 +01:00
html_context = {
'display_github': True,
'github_user': 'ALRhub',
'github_repo': 'fancy_gym',
2024-01-18 18:34:09 +01:00
'github_version': 'release/docs/source/',
}
2023-12-05 18:13:20 +01:00
def setup(app):
app.add_css_file("style.css")