Add versioning to docs

Author: FBumann

.github/workflows/deploy-docs.yaml

@@ -28,5 +28,7 @@ jobs:
           # Install all documentation dependencies directly instead of using -e .[docs]
           pip install mkdocs-material mkdocstrings-python mkdocs-table-reader-plugin mkdocs-include-markdown-plugin mkdocs-gen-files mkdocs-literate-nav markdown-include pymdown-extensions pygments
 
-      - name: Deploy documentation
-        run: mkdocs gh-deploy --force
+      - name: Deploy docs
+        run: |
+          VERSION=${GITHUB_REF#refs/tags/v}
+          mike deploy --push --update-aliases $VERSION latest

mkdocs.yml

@@ -50,6 +50,7 @@ theme:
     - content.code.annotate
     - content.tooltips
     - content.code.copy
+    - navigation.footer.version
 
 markdown_extensions:
   - admonition
@@ -83,6 +84,7 @@ plugins:
   - search  # Enables the search functionality in the documentation
   - table-reader  # Allows including tables from external files
   - include-markdown
+  - mike
   - gen-files:
       scripts:
       - scripts/gen_ref_pages.py
@@ -120,6 +122,11 @@ plugins:
            extra:
              infer_type_annotations: true  # Uses Python type hints to supplement docstring information
 
+extra:
+  version:
+    provider: mike
+    default: latest
+
 extra_javascript:
   - javascripts/mathjax.js  # Custom MathJax 3 CDN Configuration
   - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js  #MathJax 3 CDN

pyproject.toml

@@ -65,7 +65,8 @@ docs = [
     "mkdocs-literate-nav",
     "markdown-include",
     "pymdown-extensions",
-    "pygments"
+    "pygments",
+    "mike",
 ]
 
 [project.urls]