mewin/cxxheaderparser
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update sphinx configuration

Browse Source
This commit is contained in:
Dustin Spicuzza 2023-10-06 02:09:45 -04:00
parent 458d3e0795
commit 26da91836a
1 changed files with 3 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/conf.py
View File

@ -12,27 +12,19 @@ import pkg_resources
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
project = "cxxheaderparser" project = "cxxheaderparser"
copyright = "2020-2021, Dustin Spicuzza" copyright = "2020-2023, Dustin Spicuzza"
author = "Dustin Spicuzza" author = "Dustin Spicuzza"
# The full version, including alpha/beta/rc tags # The full version, including alpha/beta/rc tags
release = pkg_resources.get_distribution("cxxheaderparser").version release = pkg_resources.get_distribution("cxxheaderparser").version
# -- RTD configuration ------------------------------------------------
# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
on_rtd = os.environ.get("READTHEDOCS", None) == "True"
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = [ extensions = ["sphinx.ext.autodoc", "sphinx_autodoc_typehints", "sphinx_rtd_theme"]
"sphinx.ext.autodoc",
"sphinx_autodoc_typehints",
]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"] templates_path = ["_templates"]
@ -47,13 +39,7 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
#
if not on_rtd: # only import and set the theme if we're building docs locally
import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme" html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
else:
html_theme = "default"
always_document_param_types = True always_document_param_types = True