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
|
#!/usr/bin/env python3
#
import os
import sys
from pathlib import Path
from packaging.version import Version
HERE = Path(__file__).parent
LITE = HERE.parent / "lite"
ROOT = HERE.parent.parent
JLW = ROOT / "python/jupyterlab_widgets"
IPYW = ROOT / "python/ipywidgets"
WIDG = ROOT / "python/widgetsnbextension"
TYPD = HERE.parent / "typedoc"
NODM = ROOT / "node_modules"
TSBI = [
p.parent / "tsconfig.tsbuildinfo" for p in ROOT.glob("packages/*/tsconfig.json")
]
# work around unpickleable functions
sys.path.append(str(HERE))
from ipywidgets_docs_utils import jupyterlab_markdown_heading, run_if_needed
# silence debug messages
os.environ["PYDEVD_DISABLE_FILE_VALIDATION"] = "1"
def on_config_inited(*args):
"""rebuild"""
run_if_needed(["jlpm"], ROOT, [NODM])
run_if_needed(["jlpm", "build"], ROOT, TSBI)
run_if_needed(["jlpm", "docs"], ROOT, [TYPD / "typedoc/index.html"])
for pkg_root in [IPYW, WIDG, JLW]:
run_if_needed(["pyproject-build"], pkg_root, [pkg_root / "dist"])
run_if_needed(["jupyter", "lite", "build"], LITE)
def setup(app):
app.connect("config-inited", on_config_inited)
# -- Sphinx extensions and configuration ------------------------
extensions = [
'myst_nb',
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.intersphinx',
'sphinx.ext.mathjax',
'sphinx_autodoc_typehints',
'sphinx_copybutton',
'sphinx.ext.viewcode',
'sphinxext.rediraffe',
'IPython.sphinxext.ipython_console_highlighting',
]
intersphinx_mapping = {
'python': ('https://docs.python.org/3', None),
'ipython': ('https://ipython.readthedocs.io/en/stable/', None),
'nbconvert': ('https://nbconvert.readthedocs.io/en/stable', None),
'nbformat': ('https://nbformat.readthedocs.io/en/stable', None),
'traitlets': ('https://traitlets.readthedocs.io/en/stable', None),
}
# -- General information -------
_release = {}
exec(compile(open('../../python/ipywidgets/ipywidgets/_version.py').read(), '../../python/ipywidgets/ipywidgets/_version.py', 'exec'), _release)
v = Version(_release['__version__'])
version = f'{v.major}.{v.minor}'
release = _release['__version__']
# Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates']
master_doc = 'index'
project = 'Jupyter Widgets'
copyright = '2017-2023 Project Jupyter'
author = 'Jupyter Team'
language = "en"
exclude_patterns = [
'**.ipynb_checkpoints',
'examples.md',
'examples/Beat Frequencies.ipynb',
'examples/Controller.ipynb',
'examples/Exploring Graphs.ipynb',
'examples/Export As (nbconvert).ipynb',
'examples/Factoring.ipynb',
'examples/Imag*',
'examples/Index.ipynb',
'examples/Lorenz Differential Equations.ipynb',
'examples/Media widgets.ipynb',
'examples/Variable Inspector.ipynb',
'examples/Widget Alignment.ipynb',
'_contents'
]
pygments_style = 'sphinx'
todo_include_todos = False
myst_enable_extensions = [
"amsmath",
"colon_fence",
"deflist",
"dollarmath",
"html_image",
]
myst_heading_anchors = 4
myst_heading_slug_func = jupyterlab_markdown_heading
nb_execution_mode = "cache"
nb_ipywidgets_js = {
"require.js": {},
"embed-amd.js": {}
}
autosummary_generate = True
autoclass_content = "both"
autodoc_typehints = "none"
autodoc_default_options = {
"members": True,
"show-inheritance": True,
}
rediraffe_redirects = {
"typedoc/index": "_static/typedoc/index",
"try/lab/index": "_static/lab/index",
"try/tree/index": "_static/tree/index",
}
# -- html --------------------------
html_theme = 'pydata_sphinx_theme'
html_static_path = [
'_static',
"../../packages/html-manager/dist",
'../lite/_output',
'../typedoc',
'../../node_modules/requirejs/require.js',
]
html_css_files = [
'theme.css',
]
templates_path = ["_templates"]
htmlhelp_basename = 'ipywidgetsdoc'
html_theme_options = {
"icon_links": [
{
"name": "PyPI",
"url": "https://pypi.org/project/ipywidgets",
"icon": "fa-solid fa-box",
}
],
"use_edit_page_button": True,
"github_url": "https://github.com/jupyter-widgets/ipywidgets",
"navbar_end": [
# disabled until widget dark variables are available
# "theme-switcher",
"navbar-icon-links",
]
}
html_context = {
# disabled until widget dark variables are available
"default_mode": "light",
"doc_path": "docs",
"github_repo": "ipywidgets",
"github_user": "jupyter-widgets",
"github_version": "main",
}
html_sidebars = {
"index": [
"demo.html",
"search-field.html",
"sidebar-nav-bs-index.html",
"sidebar-ethical-ads.html",
],
"**": [
"search-field.html",
"sidebar-nav-bs.html",
"demo.html",
"sidebar-ethical-ads.html",
]
}
# -- latex -------------------------
latex_elements = {}
latex_documents = [
(master_doc, 'ipywidgets.tex', 'ipywidgets Documentation',
'https://jupyter.org', 'manual'),
]
# -- tex ---------------------------
texinfo_documents = [
(master_doc, 'ipywidgets', 'ipywidgets Documentation',
author, 'ipywidgets', 'Interactive Widgets for Jupyter.',
'Miscellaneous'),
]
# -- epub --------------------------
# Bibliographic Dublin Core info.
epub_title = project
epub_author = author
epub_publisher = author
epub_copyright = copyright
|
