Add linkcheck to docs generation workflow

.github/workflows/generate-docs.yml

@@ -93,6 +93,20 @@ jobs:
       - name: Check Spicy docs
         run: cd doc && make check-spicy-docs
 
+      - name: Run sphinx linkcheck
+        run: |
+          source ci-docs-venv/bin/activate
+          cd doc
+          set -o pipefail
+          make linkcheck > make.out 2>&1
+          make_status=$?
+          echo "*** Sphinx Linkcheck Output ***"
+          cat make.out
+          test ${make_status} -ne 0 && exit 1
+          echo "Check for Linkcheck Warnings ***"
+          grep -q WARNING make.out && exit 1
+          rm make.out
+
       # Cache pre-commit environment for reuse.
       - uses: actions/cache@v4
         with:

doc/Makefile

@@ -18,6 +18,10 @@ html: builddir
 livehtml: builddir
 	sphinx-autobuild --ignore "*.git/*" --ignore "*.lock" --ignore "*.pyc" --ignore "*.swp" --ignore "*.swpx" --ignore "*.swx" -b html $(SPHINXOPTS) . ./build/html
 
+linkcheck:
+	mkdir -p build/linkcheck
+	sphinx-build -v -b linkcheck . ./build/linkcheck
+
 commit:
 	git add * && git commit -m 'Update generated docs'