CI: Add job docs-linkcheck

Author: amotl

.github/workflows/docs.yml

@@ -0,0 +1,61 @@
+---
+name: Docs
+
+on:
+  pull_request:
+  push:
+    branches: [ main ]
+
+  # Allow job to be triggered manually.
+  workflow_dispatch:
+
+# Cancel in-progress jobs when pushing to the same branch.
+concurrency:
+  cancel-in-progress: true
+  group: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+
+  tests:
+
+    runs-on: "ubuntu-latest"
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [
+          "3.14",
+        ]
+
+    env:
+      PYTHON: ${{ matrix.python-version }}
+      UV_SYSTEM_PYTHON: true
+
+    name: Link checker
+    steps:
+
+    - name: Acquire sources
+      uses: actions/checkout@v6
+
+    - name: Set up Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Set up uv
+      uses: astral-sh/setup-uv@v7
+      with:
+        cache-dependency-glob: |
+          pyproject.toml
+        cache-suffix: ${{ matrix.python-version }}
+        enable-cache: true
+        version: "latest"
+
+    - name: Set up project
+      run: |
+
+        # Install package in editable mode.
+        uv pip install --editable='.[develop,docs]'
+
+    - name: Run link checker
+      run: |
+        poe docs-linkcheck

pyproject.toml

@@ -238,7 +238,10 @@ docs-autobuild = [
   { cmd = "sphinx-autobuild --open-browser --watch sphinx_design_elements docs docs/_build" },
 ]
 docs-html = [
-  { cmd = "sphinx-build -W --keep-going docs docs/_build" },
+  { cmd = "sphinx-build --builder=html -W --keep-going docs docs/_build" },
+]
+docs-linkcheck = [
+  { cmd = "sphinx-build --builder=linkcheck -W --keep-going docs docs/_build" },
 ]
 
 format = [