Merge pull request #3 from ru-fu/add-linkcheck

add a link checking action

.github/workflows/linkcheck.yml

@@ -0,0 +1,21 @@
+name: Link check
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  linkcheck:
+    name: Check links
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install the doc framework
+        run: |
+          make install
+
+      - name: Run linkchecker
+        run: |
+          make linkcheck

Makefile

@@ -46,6 +46,9 @@ clean-doc:
 spelling: html
 	. $(VENV) ; python3 -m pyspelling -c .sphinx/spellingcheck.yaml
 
+linkcheck:
+	. $(VENV) ; $(SPHINXBUILD) -c . -b linkcheck  "$(SOURCEDIR)" "$(BUILDDIR)"
+
 .PHONY: help Makefile
 
 # Catch-all target: route all unknown targets to Sphinx using the new

conf.py

@@ -23,7 +23,11 @@
 
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.sphinx']
 
+# Links to ignore when checking links
 
+linkcheck_ignore = [
+    'http://127.0.0.1:8000'
+    ]
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output