Add versioned documentation

.github/workflows/docs-deploy.yml

@@ -0,0 +1,49 @@
+name: Deploy docs
+
+on:
+  push:
+    branches:
+      # Main branch for development docs
+      - main
+
+      # Doc maintenance branches
+      - doc/[0-9]+.[0-9]+.[0-9]+
+
+    tags:
+      # Stable release tags
+      - v[0-9]+.[0-9]+.[0-9]+
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - name: Setup cache
+        uses: actions/cache@v4
+        with:
+          key: ${{ github.ref }}
+          path: .cache
+      - name: Setup dependencies
+        run: pip install -r docs/requirements.txt
+      - name: Configure git
+        run: |
+          git config user.name github-actions
+          git config user.email [email protected]
+      - name: Deploy development docs
+        if: github.ref == 'refs/heads/main'
+        run: mike deploy --push development unstable
+      - name: Deploy stable docs from doc branches
+        if: startsWith(github.ref, 'refs/heads/doc/')
+        run: mike deploy --push ${GITHUB_REF_NAME##*/}
+      - name: Deploy stable docs from tag
+        if: startsWith(github.ref, 'refs/tags/v')
+        # This assumes that only newer tags are pushed
+        run: mike deploy --push --update-aliases ${GITHUB_REF_NAME#v} stable latest

docs/requirements.txt

@@ -1,3 +1,4 @@
+mike~=2.1
 mkdocs-include-markdown-plugin~=7.1
 mkdocs-macros-plugin~=1.3
 mkdocs-material[imaging]~=9.5

mkdocs.yml

@@ -71,6 +71,7 @@ plugins:
   - include-markdown:
   - minify:
       minify_html: true
+  - mike:
   - social: {}
   - redirects:
       redirect_maps:
@@ -90,6 +91,9 @@ plugins:
 
 # Customization
 extra:
+  version:
+    alias: true
+    provider: mike
   annotate:
     json: [.s2]
   social: