ci(docs): deploy docs on GitHub Pages on push

Author: nolliv22

.github/workflows/deploy-docs.yaml

@@ -0,0 +1,35 @@
+name: Publish docs to GitHub Pages
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: ~/.cache 
+          restore-keys: |
+            mkdocs-material-
+      
+      - name: Install dependencies
+        run: uv sync --locked --all-extras --dev
+      
+      - name: Build docs
+        run: uv run mkdocs gh-deploy --force

Makefile

@@ -26,7 +26,4 @@ test-debug:	## Spawn an interactive shell in the test container to debug
 	@docker compose run --rm test /bin/bash
 
 doc-serve:	## Serve the documentation locally
-	@mkdocs serve
-
-doc-deploy:	## Build and deploy docs to the gh-pages branch
-	@mkdocs gh-deploy --no-history --force --strict
+	@mkdocs serve