[pre-commit] Add numpydoc

.pre-commit-config.yaml

@@ -6,6 +6,10 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
+  - repo: https://github.com/numpy/numpydoc
+    rev: v1.6.0
+    hooks:
+      - id: numpydoc-validation
   - repo: https://github.com/psf/black
     rev: 23.12.1
     hooks:

pyproject.toml

@@ -43,6 +43,7 @@ dependencies = [
   "lightning <2.2.0a0,>=2.1.0",
   "tensorboard",
   "grad-cam>=1.4.8",
+  "numpydoc",
 ]
 
 [project.urls]
@@ -256,3 +257,13 @@ line-length = 80
 addopts = ["--cov=mednet", "--cov-report=term-missing", "--import-mode=append"]
 junit_logging = "all"
 junit_log_passing_tests = false
+
+[tool.numpydoc_validation]
+checks = [
+    "all",   # report on all checks, except the below
+    "PR04",
+    "EX01",
+    "SA01",
+    "ES01",
+    "GL01",
+]