Add github pages multiversion build

.github/workflows/build_documentation.yaml

@@ -0,0 +1,49 @@
+name: build_documentation
+
+on:
+  push:
+    branches: ["**"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: build_via_sphinx_multiversion
+        run: |
+          pip install .
+          sphinx-multiversion docs/source docs/build/html
+          cp docs/build/html ./_site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/source/conf.py

@@ -21,6 +21,7 @@
 extensions = [
     "myst_parser",
     "sphinx.ext.autodoc",
+    "sphinx_multiversion",
 ]
 
 templates_path = ["_templates"]

pyproject.toml

@@ -48,7 +48,8 @@ dependencies = [
     "sphinx>=6.1.3",
     "backports.strenum",
     "typing_extensions",
-    "myst-parser"
+    "myst-parser",
+    "sphinx-multiversion",
 ]
 
 [build-system]