test mike

.github/workflows/deploy_dev_docs.yml

@@ -0,0 +1,35 @@
+name: Build and Deploy Documentation on Push
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+            enable-cache: true
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Install the project
+        run: uv sync --all-extras --dev
+
+      - name: Configure Git
+        run: |
+          git config user.name 'github-actions[bot]'
+          git config user.email 'github-actions[bot]@users.noreply.github.com'
+      - name: Build Docs Website
+        run: uv run mike deploy --push develop

.github/workflows/deploy_release_docs.yml

@@ -0,0 +1,33 @@
+name: Build and Deploy Release Documentation
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+            enable-cache: true
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Install the project
+        run: uv sync --all-extras --dev
+
+      - name: Configure Git
+        run: |
+          git config user.name 'github-actions[bot]'
+          git config user.email 'github-actions[bot]@users.noreply.github.com'
+      - name: Build Docs Website
+        run: uv run mike deploy --push --update-aliases ${{ github.event.release.tag_name }} latest

mkdocs.yml

@@ -25,6 +25,7 @@ nav:
 
 plugins:
   - gh-admonitions
+  - mike
 
 markdown_extensions:
   - admonition