Merge pull request #375 from thomaspinder/interrogate-workflow

Add interrogate workflow

.github/workflows/interrogate.yml

@@ -0,0 +1,28 @@
+name: Docstrings
+
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+    branches:
+    - main
+
+jobs:
+  Workflow:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Clone the reference repository
+      uses: actions/checkout@v3.5.2
+
+    - name: Set up Python 3.10.6
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10.6'
+
+    - name: Install dependencies
+      run: |
+        pip install -e '.[dev]'
+
+    - name: Run docstring checks
+      run: interrogate -vv dynamax --fail-under 66

pyproject.toml

@@ -4,5 +4,13 @@ requires = ["setuptools >= 30.3.0", "wheel"]
 [tool.black]
 line-length = 120
 
+[tool.interrogate]
+ignore-init-method = true
+ignore-init-module = true
+fail-under = 66
+verbose = 2
+quiet = false
+color = true
+
 [tool.ruff.lint]
 ignore = ["F722"]

setup.cfg

@@ -56,6 +56,7 @@ test =
     coverage
     pytest>=3.9
     pytest-cov
+    interrogate>=1.5.0
 
 # A combination of dependencies required for developers
 dev =