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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Imports -----------------------------------------------------------------
import sys
import os
import datetime
import re
import subprocess
# -- Path manipulation--------------------------------------------------------
sys.path.append(os.path.abspath("../tests"))
# -- Run Doxygen -------------------------------------------------------------
# Generate Doxygen documentation in the XML format.
assert subprocess.check_call("doxygen Doxyfile.in", stdout=subprocess.DEVNULL, shell=True) == 0
# -- Project information -----------------------------------------------------
project = "odc"
author = "ECMWF"
year = datetime.datetime.now().year
if year == 2021:
years = "2021"
else:
years = "2021-%s" % (year,)
copyright = "%s, %s" % (years, author)
def parse_version(ver_str):
return re.sub("^((([0-9]+)\\.)+([0-9]+)).*", "\\1", ver_str)
here = os.path.abspath(os.path.dirname(__file__))
# Get the current version directly from the source.
with open(os.path.join(here, "..", "VERSION"), "r") as f:
release = f.readline().strip() # full version string
version = parse_version(release) # feature version
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"sphinx_rtd_theme",
"sphinx_copybutton",
"sphinx_tabs.tabs",
"sphinxfortran.fortran_domain",
"breathe",
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
source_suffix = ".rst"
master_doc = "index"
pygments_style = "sphinx"
highlight_language = "c++"
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "sphinx_rtd_theme"
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
html_context = {"css_files": ["_static/style.css"]}
# Remove links to the reST sources from the page headers.
html_show_sourcelink = False
# Remove "Created using Sphinx" from the HTML footer.
html_show_sphinx = False
# -- Breathe configuration ---------------------------------------------------
breathe_projects = {"odc": "_build/xml/"}
breathe_default_project = "odc"
breathe_domain_by_file_pattern = {
"*/odc.h": "c",
"*/Odb.h": "cpp",
"*/ColumnType.h": "cpp",
"*/ColumnInfo.h": "cpp",
"*/StridedData.h": "cpp",
}
# -- Sphinx copy button configuration -----------------------------------------------
copybutton_selector = ".copybutton div.highlight pre"
# -- Sphinx Tabs configuration -----------------------------------------------
sphinx_tabs_disable_tab_closing = True
|
