Use mike for doc versioning

.github/workflows/docs.yml

@@ -1,4 +1,4 @@
-name: docs
+name: Documentation
 on:
   push:
     branches:
@@ -26,7 +26,13 @@ jobs:
         run: |
           uv sync --all-extras --dev
           uv pip install .
-      - name: Deploy MkDocs
+      - name: Get Version from pyproject.toml
+        id: version
         run: |
           source .venv/bin/activate
-          mkdocs gh-deploy --force --remote-branch gh-pages
+          echo "VERSION=$(python -c 'import importlib.metadata; print(importlib.metadata.version("brms"))')" >> $GITHUB_ENV
+      - name: Deploy MkDocs with Mike
+        run: |
+          source .venv/bin/activate
+          mike deploy --push --branch gh-pages --update-aliases ${{ env.VERSION }} latest
+          mike set-default --push --branch gh-pages latest

mkdocs.yml

@@ -1,6 +1,6 @@
 site_name: Bank Risk Management Simulation
 site_author: Mingze Gao
-site_url: https://bankrisk.org
+site_url: https://bankrisk.org/
 site_description: >-
   A bank risk management simulation framework
 
@@ -18,6 +18,7 @@ validation:
 
 theme:
   name: material
+  custom_dir: overrides
   favicon: icon.png
   logo: icon.png
   palette: 
@@ -54,8 +55,6 @@ theme:
     - search.suggest
     - search.highlight
     - search.share
-    # - content.action.edit
-    # - content.action.view
     - content.code.copy
     - content.code.select
     - content.code.annotate
@@ -70,6 +69,9 @@ theme:
 
 extra:  
   generator: false
+  version:
+    provider: mike
+    alias: true
   social:
     - icon: fontawesome/brands/github
       link: https://github.com/mgao6767/brms

overrides/main.html

@@ -0,0 +1,8 @@
+{% extends "base.html" %}
+
+{% block outdated %}
+  You're not viewing the latest version.
+  <a href="{{ '../' ~ base_url }}"> 
+    <strong>Click here to go to latest.</strong>
+  </a>
+{% endblock %}

pyproject.toml

@@ -29,6 +29,7 @@ Homepage = "https://bankrisk.org"
 [dependency-groups]
 dev = [
   "isort>=5.13.2",
+  "mike>=2.1.3",
   "mkdocs-git-revision-date-localized-plugin>=1.3.0",
   "mkdocs-material>=9.6.1",
   "pytest>=8.3.4",