/
conf.py
136 lines (98 loc) · 3.75 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
import importlib
import shutil
from pathlib import Path
author = "dynamicslab"
project = "pysindy" # package name
# no need to edit below this line
copyright = f"2020, {author}"
module = importlib.import_module(project)
version = release = getattr(module, "__version__")
master_doc = "index"
extensions = [
"nbsphinx",
"sphinxcontrib.apidoc",
"sphinx.ext.autodoc",
"sphinx.ext.todo",
"sphinx.ext.viewcode",
"sphinx.ext.autosummary",
"sphinx.ext.napoleon",
"sphinx.ext.mathjax",
"sphinx.ext.intersphinx",
"IPython.sphinxext.ipython_console_highlighting",
]
nb_execution_mode = "off"
apidoc_module_dir = f"../{project}"
apidoc_excluded_paths = ["tests"]
apidoc_toc_file = False
autodoc_default_options = {"members": True}
autodoc_member_order = "bysource"
autoclass_content = "init"
language = "en"
here = Path(__file__).parent.resolve()
if (here / "static/custom.css").exists():
html_static_path = ["static"]
exclude_patterns = ["build", "_build", "Youtube"]
# pygments_style = "sphinx"
add_module_names = True
add_function_parentheses = False
todo_include_todos = True
html_theme = "sphinx_rtd_theme"
html_show_sourcelink = False
html_show_sphinx = False
html_show_copyright = True
default_role = "any"
html_sourcelink_suffix = ""
intersphinx_mapping = {
"derivative": ("https://derivative.readthedocs.io/en/latest/", None)
}
# -- Extensions to the Napoleon GoogleDocstring class ---------------------
# michaelgoerz.net/notes/extending-sphinx-napoleon-docstring-sections.html
from sphinx.ext.napoleon.docstring import GoogleDocstring # noqa: E402
def parse_keys_section(self, section):
return self._format_fields("Keys", self._consume_fields())
GoogleDocstring._parse_keys_section = parse_keys_section
def parse_attributes_section(self, section):
return self._format_fields("Attributes", self._consume_fields())
GoogleDocstring._parse_attributes_section = parse_attributes_section
def parse_class_attributes_section(self, section):
return self._format_fields("Class Attributes", self._consume_fields())
GoogleDocstring._parse_class_attributes_section = parse_class_attributes_section
def patched_parse(self):
"""
we now patch the parse method to guarantee that the the above methods are
assigned to the _section dict
"""
self._sections["keys"] = self._parse_keys_section
self._sections["class attributes"] = self._parse_class_attributes_section
self._unpatched_parse()
GoogleDocstring._unpatched_parse = GoogleDocstring._parse
GoogleDocstring._parse = patched_parse
def setup(app):
"""Our sphinx extension for copying from examples/ to docs/examples
Since nbsphinx does not handle glob/regex paths, we need to
manually copy documentation source files from examples. See issue
# 230.
"""
doc_examples = here / "examples"
if not doc_examples.exists():
(here / "examples").mkdir()
example_source = (here / "../examples").resolve()
source_notebooks = example_source.glob("**/*.ipynb")
shutil.copy(example_source / "README.rst", doc_examples / "index.rst")
for notebook in source_notebooks:
if notebook.parent == example_source:
new_dir = doc_examples / notebook.stem
else:
new_dir = doc_examples / notebook.parent.stem
new_dir.mkdir(exist_ok=True)
new_file = new_dir / "example.ipynb"
print(f"Creating file {new_file}")
shutil.copy(notebook, new_file)
# Notebook 15 uses an image file
(doc_examples / "15_pysindy_lectures/data").mkdir(exist_ok=True)
shutil.copy(
example_source / "data/optimizer_summary.jpg",
doc_examples / "15_pysindy_lectures/data/optimizer_summary.jpg",
)
if (here / "static/custom.css").exists():
app.add_css_file("custom.css")