Add numpydoc Sphinx extension

.github/workflows/ci.yml

@@ -54,11 +54,10 @@ jobs:
     steps:
     - uses: actions/checkout@v4
 
-
     - name: Set up Python 3.11
       uses: actions/setup-python@v5
       with:
-        python-version: 3.11
+        python-version: '3.11'
 
     - name: Install poetry
       run: pipx install poetry
@@ -80,7 +79,7 @@ jobs:
     - name: Set up Python 3.11
       uses: actions/setup-python@v5
       with:
-        python-version: 3.11
+        python-version: '3.11'
 
     - name: Install poetry
       run: pipx install poetry

.github/workflows/publish-on-pypi.yml

@@ -18,7 +18,7 @@ jobs:
     - name: Set up Python 3.11
       uses: actions/setup-python@v5
       with:
-        python-version: 3.11
+        python-version: '3.11'
 
     - name: Install poetry
       run: pipx install poetry

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,9 @@
     "ase": ("https://wiki.fysik.dtu.dk/ase/", None),
 }
 
+numpydoc_validation_checks = {"all", "EX01", "SA01", "ES01"}
+numpydoc_validation_exclude = {r"\.__weakref__$", r"\.__repr__$"}
+
 # 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"