Skip to content

Commit 55eccbc

Browse files
committed
use a numpydoc 1.7.0rc0.dev0
This has a fix for NamedTuple documentation (numpy/numpydoc#527)
1 parent 6dcfbba commit 55eccbc

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

docs/source/conf.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,12 @@
2222
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
2323
# ones.
2424
extensions = [
25-
# Markdown (MyST) format support for Sphinx
26-
"myst_parser",
2725
# Adds support for NumPy style docstrings for autodoc
26+
# Note: numpydoc must be listed before myst_parser in order to make the
27+
# NamedTuples fix (https://github.com/numpy/numpydoc/pull/527) work.
2828
"numpydoc",
29+
# Markdown (MyST) format support for Sphinx
30+
"myst_parser",
2931
# Sphinx Design adds some sphinx directives for UI components
3032
# See: https://sphinx-design.readthedocs.io/
3133
"sphinx_design",

pyproject.toml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,9 @@ doc = [
3737
"sphinx-copybutton~=0.5.2",
3838
"myst-parser~=2.0.0",
3939
"sphinx-book-theme~=1.1.0",
40-
"numpydoc"
40+
# a numpydoc 1.7.0rc0.dev0. This one has https://github.com/numpy/numpydoc/pull/527 merged
41+
# At some point: Can use 1.7.0 (which is not available in PyPI at the time of writing)
42+
"numpydoc @ git+https://github.com/numpy/numpydoc.git@46f532a824639a97479039fc122533915cdfa10f"
4143
]
4244
dev = [
4345
"sphinx-autobuild",

0 commit comments

Comments
 (0)