test: periodic link check

.github/workflows/linkcheck.yml

@@ -0,0 +1,28 @@
+name: link check
+
+on:
+  schedule:
+    - cron: "0 8 * * *"
+
+jobs:
+  linkcheck:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+
+      - name: Install Poetry
+        run: |
+          curl -sSL https://install.python-poetry.org | python3 -
+          poetry --version
+
+      - name: Install dependencies
+        run: poetry install --no-interaction
+
+      - name: Check links in documentation
+        run: poetry run make -C docs linkcheck

README.rst

@@ -2,7 +2,7 @@
 sethfischer/rover
 =================
 
-|build-status| |lint-status| |test-status| |docs-status|
+|build-status| |lint-status| |test-status| |docs-status| |linkcheck-status|
 
 
 Quarter-scale Mars rover based on the NASA Mars 2020 Mission Perseverance Rover.
@@ -38,3 +38,6 @@ License
 .. |docs-status| image:: https://readthedocs.org/projects/sethfischer-osr/badge/?version=latest
     :target: https://sethfischer-osr.readthedocs.io/en/latest/?badge=latest
     :alt: Documentation Status
+.. |linkcheck-status| image:: https://github.com/sethfischer/rover/actions/workflows/linkcheck.yml/badge.svg
+    :target: https://github.com/sethfischer/rover/actions/workflows/linkcheck.yml
+    :alt: Link Check Status

docs/conf.py

@@ -43,6 +43,12 @@ def canonical_url() -> str:
 html_title = f"{project} v{release}"
 
 
+linkcheck_ignore = [
+    "https://roverchallenge.eu/",  # SSLCertVerificationError
+    "https://www.kickstarter.com/",  # returns 403 for robots
+]
+
+
 cadquery_include_source = False