Add link checks

.github/workflows/links.yml

@@ -0,0 +1,26 @@
+name: Check links
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup Python
+      uses: actions/setup-python@v1
+      with:
+        python-version: '3.9'
+        architecture: 'x64'
+
+    - name: Install dependencies
+      run: |
+        python3 -m pip install --upgrade pip
+        python3 -m pip install -r requirements.txt
+
+    - name: Check links
+      run: |
+        # This will not make anything fail on build, but at least we will know
+        pytest -s

.gitignore

@@ -13,4 +13,5 @@ docs/2023-24/year-1/t3
 docs/2023-24/year-2/t2
 docs/2023-24/year-2/t3
 docs/2023-24/research-trip
-docs/assets/images/zz
+docs/assets/images/zz
+*.log

links.sh

@@ -0,0 +1,2 @@
+#!/usr/bin/bash
+mkdocs-linkcheck docs -r --exclude assets -v -l> tests/out.log 2>tests/err.log

requirements.txt

@@ -5,6 +5,8 @@ mkdocs-macros-plugin
 mkdocs-exclude
 mistune
 mkdocs-open-in-new-tab
+mkdocs-linkcheck
+pytest
 #mkdocs-print-site-plugin
 #mkdocs-plugin-tags
 #mkdocs-with-pdf

tests/links/test_links.py

@@ -0,0 +1,13 @@
+import pytest
+import subprocess
+import os
+
+def test_links():
+    out = 0
+    try:
+        out = subprocess.call([os.path.join(os.getcwd(), "links.sh")])
+    except:
+        pass
+
+    print (out)
+    assert out == 0