Skip to content

Commit

Permalink
Spruce up the conf.py files.
Browse files Browse the repository at this point in the history
  • Loading branch information
delucchi-cmu committed Dec 15, 2023
1 parent 793b551 commit ca86323
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 13 deletions.
8 changes: 3 additions & 5 deletions docs/conf.py
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
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

0 comments on commit ca86323

Please sign in to comment.