From e7a35f8139ab7290353858ac6abe75e46bfd02e6 Mon Sep 17 00:00:00 2001
From: Thomas Pinder <tompinder@live.co.uk>
Date: Sun, 1 Sep 2024 19:58:55 +0200
Subject: [PATCH] Add interrogate workflow

---
 .github/workflows/interrogate.yml | 28 ++++++++++++++++++++++++++++
 pyproject.toml                    | 10 +++++++++-
 setup.cfg                         |  1 +
 3 files changed, 38 insertions(+), 1 deletion(-)
 create mode 100644 .github/workflows/interrogate.yml

diff --git a/.github/workflows/interrogate.yml b/.github/workflows/interrogate.yml
new file mode 100644
index 00000000..ad93ef7b
--- /dev/null
+++ b/.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@v
+
+    - name: Set up Python 3.10.6
+      uses: actions/setup-python@v2
+      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
diff --git a/pyproject.toml b/pyproject.toml
index 87a3b2c6..1f1d574d 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -2,4 +2,12 @@
 requires = ["setuptools >= 30.3.0", "wheel"]
 
 [tool.black]
-line-length = 120
\ No newline at end of file
+line-length = 120
+
+[tool.interrogate]
+ignore-init-method = true
+ignore-init-module = true
+fail-under = 66
+verbose = 2
+quiet = false
+color = true
\ No newline at end of file
diff --git a/setup.cfg b/setup.cfg
index 19a75ba4..d75bb58c 100644
--- a/setup.cfg
+++ b/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 =