-
Notifications
You must be signed in to change notification settings - Fork 268
/
conf.py
401 lines (341 loc) · 12.6 KB
/
conf.py
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
#!/usr/bin/env python3
# ctapipe documentation build configuration file, created by
# sphinx-quickstart on Fri Jan 6 10:22:58 2017.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
import datetime
import os
import sys
from pathlib import Path
from sphinx_gallery.sorting import ExplicitOrder, FileNameSortKey
import ctapipe
if sys.version_info < (3, 11):
import tomli as tomllib
else:
import tomllib
pyproject_path = Path(__file__).parent.parent / "pyproject.toml"
pyproject = tomllib.loads(pyproject_path.read_text())
# 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.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinx.ext.todo",
"sphinx.ext.coverage",
"sphinx.ext.viewcode",
"sphinx.ext.githubpages",
"sphinx.ext.mathjax",
"sphinx_automodapi.automodapi",
"sphinx_automodapi.smart_resolver",
"nbsphinx",
"matplotlib.sphinxext.plot_directive",
"numpydoc",
"sphinx_design",
"IPython.sphinxext.ipython_console_highlighting",
"sphinx_gallery.gen_gallery",
]
numpydoc_show_class_members = False
numpydoc_class_members_toctree = False
nbsphinx_timeout = 200 # allow max 2 minutes to build each notebook
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
def setup(app):
app.add_css_file("ctapipe.css")
# fix trait aliases generating doc warnings
from ctapipe.core import traits
aliases = [
"flag",
"observe",
"Bool",
"CRegExp",
"CaselessStrEnum",
"Dict",
"Enum",
"Float",
"Int",
"CInt",
"Integer",
"List",
"Long",
"Set",
"TraitError",
"Tuple",
"Unicode",
"UseEnum",
]
for alias in aliases:
getattr(traits, alias).__name__ = alias
getattr(traits, alias).__module__ = "ctapipe.core.traits"
# These links are ignored in the checks, necessary due to broken intersphinx for
# these
nitpick_ignore = [
# needed for building the docs with python 3.11 locally.
# we use the lowest supported version on readthedocs,
# so that is what we use in the intersphinx link above
("py:class", "enum.StrEnum"),
# these are coming from traitlets:
("py:class", "t.Union"),
("py:class", "t.Any"),
("py:class", "t.Dict"),
("py:class", "t.Optional"),
("py:class", "t.Type"),
("py:class", "t.List"),
("py:class", "t.Tuple"),
("py:class", "Config"),
("py:class", "traitlets.config.configurable.Configurable"),
("py:class", "traitlets.traitlets.HasTraits"),
("py:class", "traitlets.traitlets.HasDescriptors"),
("py:class", "traitlets.traitlets.TraitType"),
("py:class", "traitlets.traitlets.BaseDescriptor"),
("py:class", "traitlets.traitlets.List"),
("py:class", "traitlets.traitlets.Container"),
("py:class", "traitlets.traitlets.Instance"),
("py:class", "traitlets.traitlets.ClassBasedTraitType"),
("py:class", "traitlets.traitlets.Int"),
("py:class", "traitlets.config.application.Application"),
("py:class", "traitlets.utils.sentinel.Sentinel"),
("py:class", "traitlets.traitlets.ObserveHandler"),
("py:class", "dict[K, V]"),
("py:class", "G"),
("py:class", "K"),
("py:class", "V"),
("py:class", "t.Sequence"),
("py:class", "StrDict"),
("py:class", "ClassesType"),
("py:class", "traitlets.traitlets.G"),
("py:obj", "traitlets.traitlets.G"),
("py:obj", "traitlets.traitlets.S"),
("py:obj", "traitlets.traitlets.T"),
("py:class", "traitlets.traitlets.T"),
("py:class", "re.Pattern[t.Any]"),
("py:class", "re.Pattern"),
("py:class", "Sentinel"),
("py:class", "ObserveHandler"),
("py:obj", "traitlets.config.boolean_flag"),
("py:obj", "traitlets.TraitError"),
("py:obj", "-v"), # fix for wrong syntax in a traitlets docstring
("py:meth", "MetaHasDescriptors.__init__"),
("py:meth", "HasTraits.__new__"),
("py:meth", "BaseDescriptor.instance_init"),
("py:obj", "cls"),
("py:obj", "name"),
("py:class", "astropy.coordinates.baseframe.BaseCoordinateFrame"),
("py:class", "astropy.table.table.Table"),
("py:class", "eventio.simtel.simtelfile.SimTelFile"),
("py:class", "ctapipe.compat.StrEnum"),
("py:class", "ctapipe.compat.StrEnum"),
]
# Sphinx gallery config
sphinx_gallery_conf = {
"examples_dirs": [
"../examples",
], # path to your example scripts
"subsection_order": ExplicitOrder(
[
"../examples/tutorials",
"../examples/algorithms",
"../examples/core",
"../examples/visualization",
]
),
"within_subsection_order": FileNameSortKey,
"nested_sections": False,
"filename_pattern": r".*\.py",
"copyfile_regex": r".*\.png",
"promote_jupyter_magic": True,
"line_numbers": True,
"default_thumb_file": "_static/ctapipe_logo.png",
"pypandoc": True,
"matplotlib_animations": True,
}
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = ".rst"
# The master toctree document.
master_doc = "index"
# have all links automatically associated with the right domain.
default_role = "py:obj"
suppress_warnings = ["ref.citation"] # ignore citation not referenced warnings
# General information about the project.
project = pyproject["project"]["name"]
author = pyproject["project"]["authors"][0]["name"]
copyright = "{}. Last updated {}".format(
author, datetime.datetime.now().strftime("%d %b %Y %H:%M")
)
python_requires = pyproject["project"]["requires-python"]
# make some variables available to each page
rst_epilog = f"""
.. |python_requires| replace:: {python_requires}
"""
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
version = ctapipe.__version__
# The full version, including alpha/beta/rc tags.
release = version
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = "en"
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = [
"_build",
"Thumbs.db",
".DS_Store",
"**.ipynb_checkpoints",
"changes",
"user-guide/examples/*/README.rst",
"user-guide/examples/README.rst",
"auto_examples/index.rst",
"auto_examples/*/*.py.md5",
"auto_examples/*/*.py",
"auto_examples/*/*.ipynb",
]
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
# -- Version switcher -----------------------------------------------------
# Define the json_url for our version switcher.
json_url = "https://ctapipe.readthedocs.io/en/latest/_static/switcher.json"
# Define the version we use for matching in the version switcher.,
version_match = os.getenv("READTHEDOCS_VERSION")
# If READTHEDOCS_VERSION doesn't exist, we're not on RTD
# If it is an integer, we're in a PR build and the version isn't correct.
if not version_match or version_match.isdigit():
# For local development, infer the version to match from the package.
if "dev" in release or "rc" in release:
version_match = "latest"
else:
version_match = release
# We want to keep the relative reference when on a pull request or locally
json_url = "_static/switcher.json"
# -- Options for HTML output ----------------------------------------------
html_theme = "pydata_sphinx_theme"
html_favicon = "_static/favicon.ico"
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
html_theme_options = {
"logo": {
"image_light": "_static/ctapipe_logo.webp",
"image_dark": "_static/ctapipe_logo_dark.webp",
"alt_text": "ctapipe",
},
"github_url": "https://github.com/cta-observatory/ctapipe",
"header_links_before_dropdown": 6,
"navbar_start": ["navbar-logo", "version-switcher"],
"switcher": {
"version_match": version_match,
"json_url": json_url,
},
"navigation_with_keys": False,
"use_edit_page_button": True,
"icon_links_label": "Quick Links",
"icon_links": [
{
"name": "CTA Observatory",
"url": "https://www.cta-observatory.org/",
"type": "url",
"icon": "https://www.cta-observatory.org/wp-content/themes/ctao/favicon.ico", # noqa: E501
},
],
"announcement": """
<p>ctapipe is not stable yet, so expect large and rapid
changes to structure and functionality as we explore various
design choices before the 1.0 release.</p>
""",
}
# 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 = {
"default_mode": "light",
"github_user": "cta-observatory",
"github_repo": "ctapipe",
"github_version": "main",
"doc_path": "docs",
}
html_css_files = ["ctapipe.css"]
html_file_suffix = ".html"
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
html_title = f"{project} v{release}"
# Output file base name for HTML help builder.
htmlhelp_basename = project + "doc"
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}
# -- Options for LaTeX output --------------------------------------------------
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
("index", project + ".tex", project + " Documentation", author, "manual")
]
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [("index", project.lower(), project + " Documentation", [author], 1)]
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(
master_doc,
"ctapipe",
"ctapipe Documentation",
author,
"ctapipe",
"Experimental Data Analysis for the" "Cherenkov Telescope Array (CTA).",
"Science",
)
]
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
"python": ("https://docs.python.org/3.10", None),
"numpy": ("https://numpy.org/doc/stable/", None),
"scipy": ("https://docs.scipy.org/doc/scipy/", None),
"astropy": ("https://docs.astropy.org/en/latest/", None),
"pytables": ("https://www.pytables.org/", None),
"pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None),
"matplotlib": ("https://matplotlib.org/stable", None),
"cython": ("https://docs.cython.org/en/latest/", None),
"iminuit": ("https://scikit-hep.org/iminuit/", None),
"traitlets": ("https://traitlets.readthedocs.io/en/stable/", None),
}