link checkers for docs

Author: carl-adams-planet

.github/workflows/release-build.yml

@@ -57,6 +57,9 @@ jobs:
   #     - name: "Nox: MKDocs Build"
   #       run: |
   #         nox -s mkdocs_build
+  #     - name: "Nox: MKDocs Check Links"
+  #       run: |
+  #         nox -s mkdocs_checklinks
   #     - name: "Save Artifacts - MkDocs"
   #       uses: actions/upload-artifact@v4
   #       with:

.github/workflows/test.yml

@@ -173,3 +173,8 @@ jobs:
       - name: 'Nox: MKDocs Build'
         run: |
           nox -s mkdocs_build
+          # Not checking the links in the pipeline right now.
+          # This is throwing some false positives on intra-md links
+          # that build OK, and would also be caught by our mkdocs
+          # strict mode setting.
+          # nox -s mkdocs_checklinks

noxfile.py

@@ -176,6 +176,13 @@ def mkdocs_build(session):
     session.run("mkdocs", "-v", "build", "--clean")
 
 
+@nox.session(python=_DEFAULT_PYTHON)
+def mkdocs_checklinks(session):
+    """Check links in the documentation"""
+    session.install("-e", ".[docs]")
+    session.run("mkdocs-linkcheck", "-v", "-r", "docs")
+
+
 @nox.session(python=_DEFAULT_PYTHON)
 def mkdocs_serve(session):
     """Build the documentation and serve locally over HTTP. The server will watch for updates."""

pyproject.toml

@@ -49,7 +49,9 @@ docs = [
     "mkdocstrings[python] == 0.28.3",
     "mkdocs-click",
     "mkdocs-material == 9.6.12",  # Upgrades may interact with docs/custom_theme
-    "mkdocs-macros-plugin"
+    "mkdocs-macros-plugin",
+    "mkdocs-linkcheck",
+    # "linkcheckmd",
 ]
 examples = [
     "flask",