Fix sphinx docs linting

beetbox · Jun 11, 2024 · a4b32ac · a4b32ac
1 parent c2a13ee
commit a4b32ac
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 4 deletions.
diff --git a/.github/sphinx-problem-matcher.json b/.github/sphinx-problem-matcher.json
@@ -0,0 +1,15 @@
+{
+  "problemMatcher": [
+    {
+      "owner": "sphinx",
+      "pattern": [
+        {
+          "regexp": "^([^:]+):(\\d+): (WARNING: )?(.+)$",
+          "file": 1,
+          "line": 2,
+          "message": 4
+        }
+      ]
+    }
+  ]
+}
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -118,7 +118,11 @@ jobs:
       - name: Install dependencies
         run: poetry install --only=docs
 
-      - uses: sphinx-doc/github-problem-matcher@master
-        name: Build docs
-        with:
-          run: poe docs
+      - name: Add Sphinx problem matcher
+        run: echo "::add-matcher::.github/sphinx-problem-matcher.json"
+
+      - name: Build docs
+        run: |
+          poe docs |& tee /tmp/output
+          # fail the job if there are issues
+          grep -q " WARNING:" /tmp/output && exit 1