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
81
82
83
84
85
86
87
88
89
90
91
|
# 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
import datetime
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = "Fields DataBase - FDB"
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",
"sphinx.ext.autodoc",
"sphinx.ext.doctest",
"sphinx.ext.inheritance_diagram",
"breathe",
"sphinx.ext.autosectionlabel",
]
templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "_internal"]
autoapi_dirs = ["../src/pyfdb", "../src/z3fdb", "../src/pychunked_data_view"]
autoapi_type = "python"
autoapi_generate_api_docs = True
autoapi_add_toctree_entry = False
autoapi_python_class_content = "both"
autoapi_ignore = [
"*/_internal/*",
]
add_module_names = False
autoapi_keep_files = 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"
html_context = {"default_mode": "auto"}
html_theme_options = {
"switcher": {
"json_url": "https://sites.ecmwf.int/docs/dev-section/fdb/versions.json",
"version_match": version,
},
"show_toc_level": 2,
"icon_links": [
{
"name": "GitHub",
"url": "https://github.com/ecmwf/fdb",
"icon": "fa-brands fa-github",
},
],
"navbar_align": "left",
"navbar_start": ["navbar-logo"],
"navbar_center": ["navbar-nav"],
"navbar_end": ["navbar-icon-links", "theme-switcher", "version-switcher"],
"navbar_persistent": ["search-button"],
"secondary_sidebar_items": ["page-toc", "edit-this-page", "sourcelink"],
# On local builds no version.json is present
"check_switcher": False,
"content_footer_items": [],
"footer_start": ["copyright"],
"footer_center": [],
"footer_end": [],
}
html_sidebars = {"**": ["sidebar-nav-bs"]}
html_static_path = ["_static"]
# -- Breathe configuration ---------------------------------------------------
breathe_default_project = "FDB"
# -- autosectionlabel configuration ------------------------------------------
autosectionlabel_prefix_document = True
|
