|
a |
|
b/docs/conf.py |
|
|
1 |
# Configuration file for the Sphinx documentation builder. |
|
|
2 |
# |
|
|
3 |
# For the full list of built-in configuration values, see the documentation: |
|
|
4 |
# https://www.sphinx-doc.org/en/master/usage/configuration.html |
|
|
5 |
|
|
|
6 |
import datetime |
|
|
7 |
import os |
|
|
8 |
import sys |
|
|
9 |
|
|
|
10 |
import toml |
|
|
11 |
|
|
|
12 |
sys.path.append(os.path.join(os.path.dirname(__name__))) |
|
|
13 |
|
|
|
14 |
# -- Project information ----------------------------------------------------- |
|
|
15 |
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information |
|
|
16 |
|
|
|
17 |
toml_config = toml.load("../pyproject.toml") |
|
|
18 |
|
|
|
19 |
project = toml_config["tool"]["poetry"]["name"] |
|
|
20 |
release = toml_config["tool"]["poetry"]["version"] |
|
|
21 |
|
|
|
22 |
author = toml_config["tool"]["sphinx"]["author"] |
|
|
23 |
copyright = f"{datetime.datetime.now().year}, {author}" |
|
|
24 |
|
|
|
25 |
# -- General configuration --------------------------------------------------- |
|
|
26 |
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration |
|
|
27 |
|
|
|
28 |
extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "myst_parser"] |
|
|
29 |
|
|
|
30 |
source_suffix = { |
|
|
31 |
".rst": "restructuredtext", |
|
|
32 |
".md": "markdown", |
|
|
33 |
} |
|
|
34 |
|
|
|
35 |
templates_path = ["_templates"] |
|
|
36 |
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
|
|
37 |
|
|
|
38 |
autodoc_default_options = { |
|
|
39 |
"members": True, |
|
|
40 |
"member-order": "bysource", |
|
|
41 |
"special-members": "__getitem__,__setitem__,__len__,__eq__", |
|
|
42 |
} |
|
|
43 |
|
|
|
44 |
myst_heading_anchors = 3 |
|
|
45 |
|
|
|
46 |
# -- Options for HTML output ------------------------------------------------- |
|
|
47 |
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output |
|
|
48 |
|
|
|
49 |
html_theme = "karma_sphinx_theme" |