39 lines
1.1 KiB
Python
39 lines
1.1 KiB
Python
|
# Configuration file for the Sphinx documentation builder.
|
||
|
|
#
|
||
|
|
# For the full list of built-in configuration values, see the documentation:
|
||
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||
|
|
|
||
|
|
# -- Project information -----------------------------------------------------
|
||
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
||
|
|
|
||
|
|
project = '<project-name>'
|
||
|
|
copyright = '2024, Sam Griesemer'
|
||
|
|
author = 'Sam Griesemer'
|
||
|
|
|
||
|
|
# -- General configuration ---------------------------------------------------
|
||
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||
|
|
|
||
|
|
extensions = [
|
||
|
|
"sphinx.ext.autodoc",
|
||
|
|
"sphinx.ext.autosummary",
|
||
|
|
"sphinx.ext.viewcode",
|
||
|
|
"myst_parser",
|
||
|
|
]
|
||
|
|
autosummary_generate = True
|
||
|
|
autosummary_imported_members = True
|
||
|
|
|
||
|
|
templates_path = ['_templates']
|
||
|
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
# -- Options for HTML output -------------------------------------------------
|
||
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
||
|
|
|
||
|
|
html_theme = 'furo'
|
||
|
|
html_static_path = ['_static']
|
||
|
|
#html_sidebars = {
|
||
|
|
# '**': ['/modules.html'],
|
||
|
|
#}
|
||
|
|
|