diff --git a/docs/conf.py b/docs/conf.py index cd67600..123a3e9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,13 +20,11 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration master_doc = "index" # This assumes that sphinx-build is called from the root directory -html_favicon = 'static/favicon.ico' -html_show_sourcelink = ( - False # Remove 'view source code' from top of page (for html, not python) -) +html_favicon = "static/favicon.ico" +html_show_sourcelink = False # Remove 'view source code' from top of page (for html, not python) # Allow a custom CSS. -html_static_path = ['static',] +html_static_path = ["static"] html_css_files = ["custom.css"] # -- Options for HTML output ------------------------------------------------- diff --git a/python-project-template/{% if include_docs %}docs{% endif %}/conf.py.jinja b/python-project-template/{% if include_docs %}docs{% endif %}/conf.py.jinja index 9df0475..4fcc74c 100644 --- a/python-project-template/{% if include_docs %}docs{% endif %}/conf.py.jinja +++ b/python-project-template/{% if include_docs %}docs{% endif %}/conf.py.jinja @@ -6,12 +6,10 @@ import os import sys - -import autoapi from importlib.metadata import version # Define path to the code to be documented **relative to where conf.py (this file) is kept** -sys.path.insert(0, os.path.abspath('../src/')) +sys.path.insert(0, os.path.abspath("../src/")) # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information @@ -34,11 +32,14 @@ extensions.append("nbsphinx") {%- endif %} templates_path = [] -exclude_patterns = ['_build', '**.ipynb_checkpoints'] - -master_doc = "index" # This assumes that sphinx-build is called from the root directory -html_show_sourcelink = False # Remove 'view source code' from top of page (for html, not python) -add_module_names = False # Remove namespaces from class/method signatures +exclude_patterns = ["_build", "**.ipynb_checkpoints"] + +# This assumes that sphinx-build is called from the root directory +master_doc = "index" +# Remove 'view source code' from top of page (for html, not python) +html_show_sourcelink = False +# Remove namespaces from class/method signatures +add_module_names = False autoapi_type = "python" autoapi_dirs = ["../src"]