Merge pull request #472 into main

This changeset adds numpydoc to the documentation build requirements, better distinguishing between parameters and return values.
MIT-LCP · Dec 7, 2023 · 7b58dad · 7b58dad
2 parents 8d81359 + 4606a98
commit 7b58dad
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -44,7 +44,10 @@ def __getattr__(cls, name):
 # 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.ext.autodoc"]
+extensions = [
+    "sphinx.ext.autodoc",
+    "numpydoc",
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,3 +1,4 @@
+numpydoc<1.6
 sphinx==4.5.0
 sphinx_rtd_theme==1.0.0
 readthedocs-sphinx-search==0.1.1