1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
"""rm -rf doc/_generated/; sphinx-build doc build/sphinx/html -E -a
"""
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
from ewoksdata import __version__ as release
project = "ewoksdata"
version = ".".join(release.split(".")[:2])
copyright = "2021-2024, ESRF"
author = "ESRF"
docstitle = f"{project} {version}"
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.viewcode",
"sphinx_autodoc_typehints",
]
templates_path = ["_templates"]
exclude_patterns = []
always_document_param_types = True
# mermaid does not render when nbsphinx is used
# https://github.com/spatialaudio/nbsphinx/issues/678
nbsphinx_requirejs_path = ""
autosummary_generate = True
autodoc_default_flags = [
"members",
"undoc-members",
"show-inheritance",
]
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = "pydata_sphinx_theme"
html_static_path = []
html_theme_options = {
"icon_links": [
{
"name": "gitlab",
"url": "https://gitlab.esrf.fr/workflow/ewoks/ewoksdata",
"icon": "fa-brands fa-gitlab",
},
{
"name": "pypi",
"url": "https://pypi.org/project/ewoksdata",
"icon": "fa-brands fa-python",
},
],
"footer_start": ["copyright"],
"footer_end": ["footer_end"],
}
|
