Build docs in CI, including sphinx-lint.

jaraco · Dec 18, 2022 · 82465b9 · 82465b9
1 parent c68ac3b
commit 82465b9
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 0 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -72,11 +72,28 @@ jobs:
       - name: Run tests
         run: tox
 
+  docs:
+    runs-on: ubuntu-latest
+    env:
+      TOXENV: docs
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python }}${{ matrix.dev }}
+      - name: Install tox
+        run: |
+          python -m pip install tox
+      - name: Run tests
+        run: tox
+
   check:  # This job does nothing and is only used for the branch protection
     if: always()
 
     needs:
     - test
+    - docs
 
     runs-on: ubuntu-latest
 

diff --git a/setup.cfg b/setup.cfg
@@ -52,6 +52,7 @@ docs =
 	jaraco.packaging >= 9
 	rst.linker >= 1.9
 	furo
+	sphinx-lint
 
 	# local
 

diff --git a/tox.ini b/tox.ini
@@ -20,6 +20,7 @@ extras =
 changedir = docs
 commands =
 	python -m sphinx -W --keep-going . {toxinidir}/build/html
+	python -m sphinxlint
 
 [testenv:release]
 skip_install = True