Add numpydoc Sphinx extension

.github/workflows/ci.yml

@@ -54,18 +54,17 @@ jobs:
     steps:
     - uses: actions/checkout@v4
 
-
-    - name: Set up Python 3.11
+    - name: Set up Python 3.10
       uses: actions/setup-python@v5
       with:
-        python-version: 3.11
+        python-version: 3.10
 
     - name: Install poetry
       run: pipx install poetry
 
     - name: Install python dependencies
       run: |
-        poetry env use 3.11
+        poetry env use 3.10
         poetry install --with docs
 
     - name: Build docs

.github/workflows/docs.yml

@@ -27,6 +27,11 @@ jobs:
     steps:
     - uses: actions/checkout@v4
 
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.10
+
     - name: Install poetry
       run: |
         apt update
@@ -37,6 +42,7 @@ jobs:
     - name: sphinx
       run: |
         export PATH="$HOME/.local/bin:$PATH"
+        poetry env use 3.10
         poetry install --with docs
         cd docs
         poetry run make html

docs/source/conf.py

@@ -26,9 +26,10 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    "numpydoc",
     "sphinx.ext.autodoc",
-    "sphinx.ext.mathjax",
     "sphinx.ext.intersphinx",
+    "sphinx.ext.mathjax",
     "sphinx.ext.viewcode",
     "sphinxcontrib.contentui",
 ]
@@ -39,6 +40,8 @@
     "ase": ("https://wiki.fysik.dtu.dk/ase/", None),
 }
 
+numpydoc_validation_checks = {"all", "EX01", "SA01", "ES01"}
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 

pyproject.toml

@@ -47,6 +47,7 @@ optional = true
 [tool.poetry.group.docs.dependencies]
 furo = "^2024.1.29"
 markupsafe = "<2.1"
+numpydoc = "^1.6.0"
 sphinx = "^7.2.6"
 sphinxcontrib-contentui = "^0.2.5"
 sphinxcontrib-details-directive = "^0.1"

tox.ini

@@ -1,10 +1,10 @@
 [tox]
-envlist = py311
+envlist = py310
 
 [testenv]
 usedevelop=True
 
-[testenv:py{39,310,312}]
+[testenv:py{39,311,312}]
 description = Run the test suite against Python versions
 allowlist_externals = poetry
 commands_pre = poetry install --no-root --sync