Michael Hanke
018f5c45d5
All checks were successful
Test execution / Test-all (push) Successful in 59s
This is working towards a more structured documentation. See: orinoco/dump-things-server#214
48 lines
1.5 KiB
Python
48 lines
1.5 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
|
|
|
|
import dump_things_service
|
|
|
|
project = 'dump-things-server'
|
|
copyright = '2025-2026, Christian Mönch'
|
|
author = 'Christian Mönch'
|
|
release = dump_things_service.__version__
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
extensions = [
|
|
'sphinx.ext.autosummary',
|
|
'sphinx.ext.autodoc',
|
|
'sphinx_autodoc_typehints',
|
|
'sphinx.ext.viewcode',
|
|
]
|
|
|
|
templates_path = ['_templates']
|
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
|
|
|
primary_domain = 'py'
|
|
autoclass_content = "both"
|
|
|
|
typehints_use_signature = True
|
|
typehints_use_signature_return = True
|
|
|
|
# we build some docstrings from loguru. define some no-op substitutions
|
|
# to avoid errors
|
|
rst_prolog = """
|
|
.. |Logger| replace:: Logger
|
|
.. |add| replace:: add
|
|
.. |sys.stderr| replace:: sys.stderr
|
|
.. |str.format| replace:: str.format
|
|
"""
|
|
|
|
# -- 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']
|