Add numpydoc pre-commit

.pre-commit-config.yaml

@@ -37,3 +37,9 @@ repos:
           docs/.*|
       )$
     entry: pylint
+
+- repo: https://github.com/numpy/numpydoc
+  rev: v1.6.0
+  hooks:
+    - id: numpydoc-validation
+      files: ^janus_core/

docs/source/conf.py

@@ -34,15 +34,15 @@
     "sphinxcontrib.contentui",
 ]
 
+numpydoc_validation_checks = {"all", "EX01", "SA01", "ES01"}
+numpydoc_validation_exclude = {r"\.__weakref__$", r"\.__repr__$"}
+
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
     "numpy": ("https://numpy.org/doc/stable/", None),
     "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

@@ -85,3 +85,17 @@ source=["janus_core"]
 line_length = 120
 force_sort_within_sections = true
 sections = ['FUTURE', 'STDLIB', 'THIRDPARTY', 'FIRSTPARTY', 'LOCALFOLDER']
+
+[tool.numpydoc_validation]
+# report on all checks, except the below
+checks = [
+    "all",
+    "EX01",
+    "SA01",
+    "ES01",
+]
+# Don't report on objects that match any of these regex
+exclude = [
+    ".__weakref__$",
+    ".__repr__$",
+]