feature: publishing versioned data via mike

Author: mattkae

.github/workflows/develop.yml

@@ -0,0 +1,27 @@
+name: Build/Publish Develop Docs 
+on:
+  push:
+    branches:
+      - master
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.10.6
+      - name: Install Dependencies
+        run: |
+          pip install mkdocs-material
+          pip install pillow cairosvg mike
+      - name: Setup Docs Deploy
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - name: Build Docs Website
+        run: mike deploy --push develop

.github/workflows/publish.yml

@@ -1,37 +1,28 @@
-name: ci 
-
+name: Build/Publish Latest Release Docs
 
 on:
-  push:
-    branches:
-      - master 
+  release:
+    types: [published]
 
 permissions:
   contents: write
-
 jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - name: Configure Git Credentials
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.10.6
+      - name: Install Dependencies
+        run: |
+          pip install mkdocs-material
+          pip install pillow cairosvg mike
+      - name: Setup Docs Deploy
         run: |
           git config user.name github-actions[bot]
           git config user.email 41898282+github-actions[bot]@users.noreply.github.com
-          
-      - uses: actions/setup-python@v5
-        with:
-          python-version: 3.x
-      - 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-
-      - run: pip install mkdocs-material 
-
-
-      - run: mkdocs gh-deploy --force
+      - name: Build Docs Website
+        run: mike deploy --push --update-aliases ${{ github.event.release.tag_name }} latest

mkdocs.yml

@@ -30,3 +30,6 @@ nav:
   - Mir's Built-in Configuration: configuration/mir.md
   - Display Configuration: configuration/display_configuration.md
   - Roadmap: roadmap.md
+extra:
+  version:
+    provider: mike

requirements.txt

@@ -1,2 +1,3 @@
 mkdocs
-mkdocs-material
+mkdocs-material
+mike