-
Notifications
You must be signed in to change notification settings - Fork 29
/
conf.py
553 lines (470 loc) · 16.9 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
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
# 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
# -- Path setup --------------------------------------------------------------
# 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 inspect
import os
import re
import sys
sys.path.insert(0, os.path.abspath("."))
sys.path.insert(0, os.path.abspath(".."))
# Need to build docs with Python 3.8 or higher for proper typing annotations, including from __future__ import annotations
assert sys.version_info.major == 3 and sys.version_info.minor >= 8
# Assign a build variable to the builtin module that inerts the @set_module decorator. This is done because set_module
# confuses Sphinx when parsing overloaded functions. When not building the documentation, the @set_module("galois")
# decorator works as intended.
import builtins
setattr(builtins, "__sphinx_build__", True)
import numpy
import sphinx
import galois
# -- Project information -----------------------------------------------------
project = "galois"
copyright = "2020-2024, Matt Hostetter"
author = "Matt Hostetter"
version = galois.__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.ext.autodoc",
"sphinx.ext.napoleon",
"sphinx.ext.mathjax",
"sphinx.ext.intersphinx",
"sphinx_last_updated_by_git",
"sphinx_immaterial",
"sphinx_immaterial.apidoc.python.apigen",
"sphinx_math_dollar",
"myst_parser",
"sphinx_design",
"IPython.sphinxext.ipython_console_highlighting",
"IPython.sphinxext.ipython_directive",
"ipython_with_reprs",
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
source_suffix = [".rst", ".md", ".ipynb"]
# Tell sphinx that ReadTheDocs will create an index.rst file as the main file,
# not the default of contents.rst.
master_doc = "index"
# 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 pattern also affects html_static_path and html_extra_path.
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".ipynb_checkpoints"]
# -- 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_immaterial"
# 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_css_files = [
"extra.css",
]
# Define a custom inline Python syntax highlighting literal
rst_prolog = """
.. role:: python(code)
:language: python
:class: highlight
"""
# Sets the default role of `content` to :python:`content`, which uses the custom Python syntax highlighting inline literal
default_role = "python"
html_title = "galois"
html_favicon = "../logo/galois-favicon-color.png"
html_logo = "../logo/galois-favicon-white.png"
# Sphinx Immaterial theme options
html_theme_options = {
"icon": {
"repo": "fontawesome/brands/github",
},
"site_url": "https://galois.readthedocs.io/",
"repo_url": "https://github.com/mhostetter/galois",
"repo_name": "mhostetter/galois",
"social": [
{
"icon": "fontawesome/brands/github",
"link": "https://github.com/mhostetter/galois",
},
{
"icon": "fontawesome/brands/python",
"link": "https://pypi.org/project/galois/",
},
{
"icon": "fontawesome/brands/twitter",
"link": "https://twitter.com/galois_py",
},
],
"edit_uri": "",
"globaltoc_collapse": False,
"features": [
# "navigation.expand",
"navigation.tabs",
# "toc.integrate",
# "navigation.sections",
# "navigation.instant",
# "header.autohide",
"navigation.top",
"navigation.tracking",
"toc.follow",
"toc.sticky",
"content.tabs.link",
"announce.dismiss",
],
"palette": [
{
"media": "(prefers-color-scheme: light)",
"scheme": "default",
"primary": "indigo",
"accent": "indigo",
"toggle": {
"icon": "material/weather-night",
"name": "Switch to dark mode",
},
},
{
"media": "(prefers-color-scheme: dark)",
"scheme": "slate",
"primary": "black",
"accent": "indigo",
"toggle": {
"icon": "material/weather-sunny",
"name": "Switch to light mode",
},
},
],
"analytics": {
"provider": "google",
"property": "G-4FW9NCNFZH",
},
"version_dropdown": True,
"version_json": "../versions.json",
}
html_last_updated_fmt = ""
html_use_index = True
html_domain_indices = True
# -- Extension configuration -------------------------------------------------
# Create hyperlinks to other documentation
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"numpy": ("https://numpy.org/doc/stable/", None),
}
autodoc_default_options = {
"imported-members": True,
"members": True,
# "special-members": True,
# "inherited-members": "ndarray",
# "member-order": "groupwise",
}
autodoc_typehints = "signature"
autodoc_typehints_description_target = "documented"
autodoc_typehints_format = "short"
autodoc_type_aliases = {
"ElementLike": "~typing.ElementLike",
"IterableLike": "~typing.IterableLike",
"ArrayLike": "~typing.ArrayLike",
"ShapeLike": "~typing.ShapeLike",
"DTypeLike": "~typing.DTypeLike",
"PolyLike": "~typing.PolyLike",
}
ipython_execlines = ["import math", "import numpy as np", "import galois"]
myst_enable_extensions = ["dollarmath"]
mathjax_config = {
"tex2jax": {
"inlineMath": [["\\(", "\\)"]],
"displayMath": [["\\[", "\\]"]],
},
}
mathjax3_config = {
"tex": {
"inlineMath": [["\\(", "\\)"]],
"displayMath": [["\\[", "\\]"]],
}
}
# -- Sphinx Immaterial configs -------------------------------------------------
# Python apigen configuration
python_apigen_modules = {
"galois": "api/galois.",
"galois.typing": "api/galois.typing.",
}
python_apigen_default_groups = [
("class:.*", "Classes"),
("data:.*", "Variables"),
("function:.*", "Functions"),
("classmethod:.*", "Class methods"),
("method:.*", "Methods"),
(r"method:.*\.[A-Z][A-Za-z,_]*", "Constructors"),
(r"method:.*\.__[A-Za-z,_]*__", "Special methods"),
(r"method:.*\.__(init|new)__", "Constructors"),
(r"method:.*\.__(str|repr)__", "String representation"),
("property:.*", "Properties"),
(r".*:.*\.is_[a-z,_]*", "Attributes"),
]
python_apigen_default_order = [
("class:.*", 10),
("data:.*", 11),
("function:.*", 12),
("classmethod:.*", 40),
("method:.*", 50),
(r"method:.*\.[A-Z][A-Za-z,_]*", 20),
(r"method:.*\.__[A-Za-z,_]*__", 28),
(r"method:.*\.__(init|new)__", 20),
(r"method:.*\.__(str|repr)__", 30),
("property:.*", 60),
(r".*:.*\.is_[a-z,_]*", 70),
]
python_apigen_order_tiebreaker = "alphabetical"
python_apigen_case_insensitive_filesystem = False
python_apigen_show_base_classes = True
# Python domain directive configuration
python_type_aliases = autodoc_type_aliases
python_module_names_to_strip_from_xrefs = ["collections.abc"]
# General API configuration
object_description_options = [
("py:.*", dict(include_rubrics_in_toc=True)),
]
sphinx_immaterial_custom_admonitions = [
{
"name": "note",
"title": "Note",
"classes": ["collapsible"],
"icon": "fontawesome/solid/pencil",
"override": True,
},
{
"name": "warning",
"title": "Warning",
"classes": ["collapsible"],
"icon": "fontawesome/solid/exclamation",
"override": True,
},
{
"name": "info",
"icon": "fontawesome/solid/circle-info",
"override": True,
},
{
"name": "tip",
"icon": "fontawesome/regular/lightbulb",
"override": True,
},
{
"name": "abstract",
"icon": "fontawesome/regular/file-lines",
"override": True,
},
{
"name": "important",
"icon": "fontawesome/solid/bolt",
"override": True,
},
{
"name": "example",
"icon": "fontawesome/solid/terminal",
"override": True,
},
{
"name": "quote",
"icon": "fontawesome/solid/quote-left",
"override": True,
},
{
"name": "question",
"title": "Question",
"classes": ["collapsible"],
"icon": "fontawesome/solid/question",
"color": (108, 117, 125), # --sd-color-secondary
"override": True,
},
{
"name": "seealso",
"title": "See also",
"classes": ["collapsible"],
"icon": "fontawesome/solid/magnifying-glass",
"color": (108, 117, 125), # --sd-color-secondary
"override": True,
},
{
"name": "versionadded",
"icon": "fontawesome/solid/code-commit",
"override": True,
},
{
"name": "versionchanged",
"icon": "fontawesome/solid/code-branch",
"override": True,
},
{
# This needs to be defined here so the icon is available when referenced in _templates/base.html
"name": "star",
"icon": "fontawesome/regular/star",
"color": (255, 233, 3), # Gold
},
{
"name": "nomenclature",
"title": "Variable nomenclature",
"classes": ["collapsible"],
"icon": "fontawesome/solid/arrow-down-a-z",
"color": (108, 117, 125), # --sd-color-secondary
},
{
"name": "fast-performance",
"title": "Faster performance",
"icon": "material/speedometer",
"color": (47, 177, 112), # Green: --md-code-hl-string-color
},
{
"name": "slow-performance",
"title": "Slower performance",
"icon": "material/speedometer-slow",
"color": (230, 105, 91), # Red: --md-code-hl-number-color
},
]
# -- Monkey-patching ---------------------------------------------------------
SPECIAL_MEMBERS = [
"__repr__",
"__str__",
"__int__",
"__call__",
"__len__",
"__eq__",
]
def autodoc_skip_member(app, what, name, obj, skip, options):
"""
Instruct autodoc to skip members that are inherited from np.ndarray.
"""
if skip:
# Continue skipping things Sphinx already wants to skip
return skip
if name == "__init__":
return False
elif hasattr(obj, "__objclass__"):
# This is a NumPy method, don't include docs
return True
elif getattr(obj, "__qualname__", None) in ["FunctionMixin.dot", "Array.astype"]:
# NumPy methods that were overridden, don't include docs
return True
elif (
hasattr(obj, "__qualname__")
and getattr(obj, "__qualname__").split(".")[0] == "FieldArray"
and hasattr(numpy.ndarray, name)
):
if name in ["__repr__", "__str__"]:
# Specifically allow these methods to be documented
return False
else:
# This is a NumPy method that was overridden in one of our ndarray subclasses. Also don't include
# these docs.
return True
if name in SPECIAL_MEMBERS:
# Don't skip members in "special-members"
return False
if name[0] == "_":
# For some reason we need to tell Sphinx to hide private members
return True
return skip
def autodoc_process_bases(app, name, obj, options, bases):
"""
Remove private classes or mixin classes from documented class bases.
"""
# Determine the bases to be removed
remove_bases = []
for base in bases:
if base.__name__[0] == "_" or "Mixin" in base.__name__:
remove_bases.append(base)
# Remove from the bases list in-place
for base in remove_bases:
bases.remove(base)
# Only during Sphinx builds, monkey-patch the metaclass properties into this class as "class properties". In Python 3.9 and greater,
# class properties may be created using `@classmethod @property def foo(cls): return "bar"`. In earlier versions, they must be created
# in the metaclass, however Sphinx cannot find or document them. Adding this workaround allows Sphinx to document them.
def classproperty(obj):
ret = classmethod(obj)
ret.__doc__ = obj.__doc__
return ret
ArrayMeta_properties = [
member for member in dir(galois.Array) if inspect.isdatadescriptor(getattr(type(galois.Array), member, None))
]
for p in ArrayMeta_properties:
# Fetch the class properties from the private metaclasses
ArrayMeta_property = getattr(galois._domains._meta.ArrayMeta, p)
# Temporarily delete the class properties from the private metaclasses
delattr(galois._domains._meta.ArrayMeta, p)
# Add a Python 3.9 style class property to the public class
setattr(galois.Array, p, classproperty(ArrayMeta_property))
# Add back the class properties to the private metaclasses
setattr(galois._domains._meta.ArrayMeta, p, ArrayMeta_property)
FieldArrayMeta_properties = [
member
for member in dir(galois.FieldArray)
if inspect.isdatadescriptor(getattr(type(galois.FieldArray), member, None))
]
for p in FieldArrayMeta_properties:
# Fetch the class properties from the private metaclasses
if p in ArrayMeta_properties:
ArrayMeta_property = getattr(galois._domains._meta.ArrayMeta, p)
FieldArrayMeta_property = getattr(galois._fields._meta.FieldArrayMeta, p)
# Temporarily delete the class properties from the private metaclasses
if p in ArrayMeta_properties:
delattr(galois._domains._meta.ArrayMeta, p)
delattr(galois._fields._meta.FieldArrayMeta, p)
# Add a Python 3.9 style class property to the public class
setattr(galois.FieldArray, p, classproperty(FieldArrayMeta_property))
# Add back the class properties to the private metaclasses
if p in ArrayMeta_properties:
setattr(galois._domains._meta.ArrayMeta, p, ArrayMeta_property)
setattr(galois._fields._meta.FieldArrayMeta, p, FieldArrayMeta_property)
def autodoc_process_signature(app, what, name, obj, options, signature, return_annotation):
signature = modify_type_hints(signature)
return_annotation = modify_type_hints(return_annotation)
return signature, return_annotation
def modify_type_hints(signature):
"""
Fix shortening numpy type annotations in string annotations created with
`from __future__ import annotations` that Sphinx can't process before Python
3.10.
See https://github.com/jbms/sphinx-immaterial/issues/161
"""
if signature:
signature = re.sub(r"(?<!~)np\.", "~numpy.", signature)
signature = re.sub(r"(?<!~)galois\.", "~galois.", signature)
return signature
def monkey_patch_parse_see_also():
"""
Use the NumPy docstring parsing of See Also sections for convenience. This automatically
hyperlinks plaintext functions and methods.
"""
# Add the special parsing method from NumpyDocstring
method = sphinx.ext.napoleon.NumpyDocstring._parse_numpydoc_see_also_section
sphinx.ext.napoleon.GoogleDocstring._parse_numpydoc_see_also_section = method
def _parse_see_also_section(self, section: str):
"""Copied from NumpyDocstring._parse_see_also_section()."""
lines = self._consume_to_next_section()
# Added: strip whitespace from lines to satisfy _parse_numpydoc_see_also_section()
for i in range(len(lines)):
lines[i] = lines[i].strip()
try:
return self._parse_numpydoc_see_also_section(lines)
except ValueError:
return self._format_admonition("seealso", lines)
sphinx.ext.napoleon.GoogleDocstring._parse_see_also_section = _parse_see_also_section
def setup(app):
monkey_patch_parse_see_also()
app.connect("autodoc-skip-member", autodoc_skip_member)
app.connect("autodoc-process-bases", autodoc_process_bases)
app.connect("autodoc-process-signature", autodoc_process_signature)