40 lines
1.3 KiB
Python
40 lines
1.3 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 = "qubed"
|
|
copyright = "2025, Tom Hodson (ECMWF)"
|
|
author = "Tom Hodson (ECMWF)"
|
|
release = "0.1.0"
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
extensions = [
|
|
"sphinx.ext.autodoc", # for generating documentation from the docstrings in our code
|
|
"sphinx.ext.napoleon", # for parsing Numpy and Google stye docstrings
|
|
"myst_nb", # For parsing markdown
|
|
]
|
|
|
|
templates_path = ["_templates"]
|
|
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "jupyter_execute"]
|
|
|
|
|
|
source_suffix = {
|
|
".rst": "restructuredtext",
|
|
}
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
|
|
|
html_theme = "sphinx_rtd_theme"
|
|
html_static_path = ["_static"]
|
|
|
|
myst_enable_extensions = [
|
|
"attrs_inline",
|
|
]
|