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
|
# 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 awkward
import datetime
import os
import runpy
import pathlib
# -- Project information -----------------------------------------------------
project = "Awkward Array"
copyright = f"{datetime.datetime.now().year}, Awkward Array development team"
author = "Jim Pivarski"
parts = awkward.__version__.split(".")
version = ".".join(parts[:2])
release = ".".join(parts)
# -- Environment variables ---------------------------------------------------
# Allow the CI to set version_match="main"
version_match = os.environ.get("DOCS_VERSION", version)
canonical_version = os.environ.get("DOCS_CANONICAL_VERSION")
report_analytics = os.environ.get("DOCS_REPORT_ANALYTICS", False)
show_version_switcher = os.environ.get("DOCS_SHOW_VERSION", False)
run_cuda_notebooks = os.environ.get("DOCS_RUN_CUDA", False)
# -- 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_copybutton",
"sphinx_design",
"sphinx_external_toc",
"sphinx.ext.intersphinx",
"myst_nb",
# Preserve old links
# "jupyterlite_sphinx",
"IPython.sphinxext.ipython_console_highlighting",
"IPython.sphinxext.ipython_directive",
]
# Specify a canonical version
if canonical_version is not None:
html_baseurl = f"https://awkward-array.org/doc/{canonical_version}/"
# Build sitemap on main
if version_match == canonical_version:
extensions.append("sphinx_sitemap")
# Sitemap URLs are relative to `html_baseurl`
sitemap_url_scheme = "{link}"
# 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", "_templates", "Thumbs.db", "jupyter_execute", ".*"]
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_context = {
"github_user": "scikit-hep",
"github_repo": "awkward",
"github_version": "main",
"doc_path": "docs",
}
html_theme = "pydata_sphinx_theme"
html_show_sourcelink = True
html_theme_options = {
"logo": {
"image_light": "_static/image/logo-300px.png",
"image_dark": "_static/image/logo-300px-white.png",
},
"github_url": "https://github.com/scikit-hep/awkward",
# Add light/dark mode and documentation version switcher:
"navbar_end": ["theme-switcher", "navbar-icon-links"],
"footer_start": ["copyright", "sphinx-version", "funding"],
"icon_links": [
{
"name": "PyPI",
"url": "https://pypi.org/project/awkward",
"icon": "fa-brands fa-python",
},
{
"name": "Gitter",
"url": "https://gitter.im/Scikit-HEP/awkward-array",
"icon": "fa-brands fa-gitter",
},
],
"use_edit_page_button": True,
"external_links": [
{
"name": "Contributor guide",
"url": "https://github.com/scikit-hep/awkward/blob/main/CONTRIBUTING.md",
},
{
"name": "Release history",
"url": "https://github.com/scikit-hep/awkward/releases",
},
],
}
# Disable analytics for previews
if report_analytics:
html_theme_options["analytics"] = {
"plausible_analytics_domain": "awkward-array.org",
"plausible_analytics_url": "https://views.scientific-python.org/js/plausible.js",
}
# Don't show version for offline builds by default
if show_version_switcher:
html_theme_options["switcher"] = {
"json_url": "https://awkward-array.org/doc/switcher.json",
"version_match": version_match,
}
html_theme_options["navbar_start"] = ["navbar-logo", "version-switcher"]
# 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 = ["css/awkward.css"]
html_js_files = ["js/awkward.js"]
# MyST settings
myst_enable_extensions = ["colon_fence"]
nb_execution_mode = "cache"
nb_execution_raise_on_error = True
# unpkg is currently _very_ slow
nb_ipywidgets_js = {
# Load RequireJS, used by the IPywidgets for dependency management
"https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js": {
"integrity": "sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=",
"crossorigin": "anonymous",
},
# Load IPywidgets bundle for embedding.
"https://cdn.jsdelivr.net/npm/@jupyter-widgets/html-manager@0.20.0/dist/embed-amd.js": {
"data-jupyter-widgets-cdn": "https://cdn.jsdelivr.net/npm/",
"crossorigin": "anonymous",
},
}
nb_execution_show_tb = True
if not run_cuda_notebooks:
nb_execution_excludepatterns = [
# We have no CUDA executors, so disable this
"user-guide/how-to-use-in-numba-cuda.ipynb",
# We have no cppyy 3.0.1 yet, so disable this
"user-guide/how-to-use-in-cpp-cppyy.ipynb",
]
# Additional stuff
master_doc = "index"
# Cross-reference existing Python objects
intersphinx_mapping = {
"python": ("https://docs.python.org/3/", None),
"pandas": ("https://pandas.pydata.org/pandas-docs/stable", None),
"numpy": ("https://numpy.org/doc/stable", None),
"scipy": ("https://docs.scipy.org/doc/scipy", None),
"numba": ("https://numba.pydata.org/numba-doc/latest", None),
"arrow": ("https://arrow.apache.org/docs/", None),
"jax": ("https://jax.readthedocs.io/en/latest", None),
}
# JupyterLite configuration
jupyterlite_dir = "./lite"
# Don't override ipynb format
jupyterlite_bind_ipynb_suffix = False
# We've disabled localstorage, so we must provide the contents explicitly
jupyterlite_contents = ["getting-started/demo/*"]
linkcheck_ignore = [
r"^https?:\/\/github\.com\/.*$",
r"^getting-started\/try-awkward-array\.html$", # Relative link won't resolve
r"^https?:\/\/$", # Bare https:// allowed
]
# Eventually we need to revisit these
if (datetime.date.today() - datetime.date(2022, 12, 13)) < datetime.timedelta(days=30):
linkcheck_ignore.extend(
[
r"^https:\/\/doi.org\/10\.1051\/epjconf\/202024505023$",
r"^https:\/\/doi.org\/10\.1051\/epjconf\/202125103002$",
]
)
# Generate Python docstrings
HERE = pathlib.Path(__file__).parent
runpy.run_path(HERE / "prepare_docstrings.py", run_name="__main__")
# Sphinx doesn't usually want content to fit the screen, so we hack the styles for this page
def install_jupyterlite_styles(app, pagename, templatename, context, event_arg) -> None:
if pagename != "getting-started/try-awkward-array":
return
app.add_css_file("css/try-awkward-array.css")
def setup(app):
app.connect("html-page-context", install_jupyterlite_styles)
|
