Add workflow to deploy mkdocs

Author: stfnkth

.github/workflows/deploy-docs.yml

@@ -0,0 +1,50 @@
+name: Build and deploy docs
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+  pull_request:
+    branches:
+      - "*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: pip install -r requirements.docs.txt
+
+      - name: Build docs
+        run: mkdocs build -d dist
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./dist
+
+  deploy:
+    needs: build
+    if: github.ref == 'refs/heads/main'
+    permissions:
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/pytest.yml

@@ -1,4 +1,4 @@
-name: Python package
+name: Test package
 
 on: [push]
 

requirements.docs.txt

@@ -0,0 +1,3 @@
+mkdocs>=1.6.1
+mkdocs-material>=9.6.12
+mkdocstrings[python]>=0.29.1