File tree 1 file changed +12
-5
lines changed
1 file changed +12
-5
lines changed Original file line number Diff line number Diff line change 1
- # Base configuration file for the Sphinx documentation builder.
2
- #
3
- # This file only contains a selection of the most common options. For a full
4
- # list see the documentation:
5
- # https://www.sphinx-doc.org/en/master/usage/configuration.html
1
+ """
2
+ Base config for all individual Sphinx docs in the array API repo.
3
+
4
+ The array-api repo contains an individual Sphinx doc for each spec version, all
5
+ of which exist in ../spec/. This file is star-imported in the conf.py files of
6
+ these docs, allowing us to standardize configuration accross API versions.
7
+
8
+ Every conf.py file which star-imports this should define
9
+
10
+ * `release`, the str YYYY.MM release. Use "DRAFT" for the draft.
11
+ * `sys.modules['array_api']`, the stubs module to use for autodoc.
12
+ """
6
13
import re
7
14
8
15
import sphinx_material
You can’t perform that action at this time.
0 commit comments