Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Spruce up the conf.py files. #337

Merged
merged 1 commit into from
Dec 15, 2023
Merged

Spruce up the conf.py files. #337

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 -------------------------------------------------
Expand Down
17 changes: 9 additions & 8 deletions python-project-template/{% if include_docs %}docs{% endif %}/conf.py.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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"]
Expand Down