Skip to content

Commit

Permalink
Update sphinx configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
virtuald committed Oct 6, 2023
1 parent 458d3e0 commit 26da918
Showing 1 changed file with 3 additions and 17 deletions.
20 changes: 3 additions & 17 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,27 +12,19 @@
# -- Project information -----------------------------------------------------

project = "cxxheaderparser"
copyright = "2020-2021, Dustin Spicuzza"
copyright = "2020-2023, Dustin Spicuzza"
author = "Dustin Spicuzza"

# The full version, including alpha/beta/rc tags
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 ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"sphinx.ext.autodoc",
"sphinx_autodoc_typehints",
]
extensions = ["sphinx.ext.autodoc", "sphinx_autodoc_typehints", "sphinx_rtd_theme"]

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
Expand All @@ -47,13 +39,7 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# 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_path = [sphinx_rtd_theme.get_html_theme_path()]
else:
html_theme = "default"
html_theme = "sphinx_rtd_theme"

always_document_param_types = True

0 comments on commit 26da918

Please sign in to comment.