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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
# 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
# NOTE: This configuration uses autoapi without automatic generation and
# instead uses directives (see api.rst). This is done because with just
# autoapi auto generation all modules must be imported. In ource case this
# would mean we need to complie our python bindings. Using autoapi with
# directives allows to use 'static analysis' mode to extract docstrings.default_mod
# See: https://sphinx-autoapi.readthedocs.io/en/stable/how_to.html#how-to-transition-to-autodoc-style-documentation
# See: https://sphinx-autoapi.readthedocs.io/en/stable/reference/directives.html
import datetime
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = "z3FDB"
copyright = f"{datetime.datetime.today().year}, ECMWF"
author = "ECMWF"
version = "local-dev"
release = "local-dev"
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
"sphinx.ext.autosectionlabel",
"sphinxcontrib.mermaid",
"autoapi.extension",
"sphinx.ext.viewcode",
"sphinx.ext.napoleon",
]
# -- Autoapi settings
autoapi_dirs = ["../../src/z3fdb", "../../src/pychunked_data_view"]
autoapi_type = "python"
autoapi_generate_api_docs = False
autoapi_add_toctree_entry = False
autoapi_python_class_content = "class"
autoapi_ignore = [
"*/_internal/*",
]
add_module_names = False
# -- Napoleon settings
napoleon_google = True
templates_path = ["_templates"]
exclude_patterns = ["Thumbs.db", ".DS_Store"]
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = "pydata_sphinx_theme"
# Do not show source link on each page
html_show_sourcelink = False
html_sidebars = {
"**": [],
}
html_theme_options = {
"navbar_align": "left",
"navbar_start": ["navbar-logo"],
"navbar_center": ["navbar-nav"],
"navbar_end": ["navbar-icon-links", "theme-switcher", "version-switcher"],
"navbar_persistent": ["search-button"],
"primary_sidebar_end": [],
# On local builds no version.json is present
"check_switcher": False
}
html_context = {
# Enable auto detection of light/dark mode
"default_mode": "auto"
}
# -- autosectionlabel configuration ------------------------------------------
autosectionlabel_prefix_document = True
|
