chore: configure main and latest versions to docs (#683)

Author: kangasta

.github/workflows/docs.yml

@@ -39,11 +39,13 @@ jobs:
           name: mkdocs-site
           path: site
           retention-days: 7
-      - name: Deploy to pages
-        if: ${{ github.ref_name == 'main' || github.event_name == 'release'}}
-        uses: JamesIves/github-pages-deploy-action@d92aa235d04922e8f08b40ce78cc5442fcfbfa2f # 4.8.0
-        with:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          BRANCH: gh-pages
-          FOLDER: site
-          CLEAN: true
+      - name: Setup git user for mike
+        run: |
+          git config --global user.name "${{ github.actor }}"
+          git config --global user.email "${{ github.actor }}@users.noreply.github.com"
+      - name: Deploy to main
+        if: ${{ github.ref_name == 'main' }}
+        run: mike deploy --push --title "Unreleased (main)" main
+      - name: Deploy to latest
+        if: ${{ github.event_name == 'release' }}
+        run: mike deploy --push --title "Latest (${{ github.event.release.tag_name }})" latest

mkdocs.base.yaml

@@ -35,6 +35,11 @@ plugins:
       include_yaml:
         - vars.yaml
 
+extra:
+  version:
+    default: latest
+    provider: mike
+
 markdown_extensions:
   - pymdownx.highlight:
       anchor_linenums: true

requirements.txt

@@ -1,4 +1,5 @@
 # Dependencies for auto-generating and developing docs
+mike~=2.1
 mkdocs~=1.5
 mkdocs-material~=9.5
 mkdocs-macros-plugin~=1.0