Add suport for mike serve

.github/workflows/docs.yaml

@@ -2,6 +2,7 @@
 name: Publish Develop Docs 
 
 on:
+  pull_request:
   push:
     branches:
       - main
@@ -31,4 +32,6 @@ jobs:
           git config user.name "GitHub Action"
       - name: Build Documentation
         run: |
-          nox -s docs -- gh-deploy --force --remote-branch gh-pages
+          git fetch origin gh-pages:gh-pages
+          nox -s docs -- deploy --update-aliases dev
+          git push origin gh-pages

mkdocs.yml

@@ -27,6 +27,7 @@ theme:
         name: Switch to dark mode
 plugins:
   search: null
+  mike: null
   mkdocstrings:
     handlers:
       python:
@@ -42,6 +43,9 @@ plugins:
           show_root_heading: true
           filters:
           - '!^_'
+extra:
+  version:
+    provider: mike
 markdown_extensions:
   - toc:
       toc_depth: 2

noxfile.py

@@ -144,7 +144,7 @@ def docs(session: nox.Session) -> None:
     """Builds and deploys the code documentation."""
     args = session.posargs or []
     session.run_always("pdm", "install", "--group", "docs", external=True)
-    session.run("pdm", "run", "mkdocs", *args)
+    session.run("pdm", "run", "mike", *args)
 
 
 @nox.session

pyproject.toml

@@ -84,8 +84,13 @@ test = [
 ]
 docs = [
     "mkdocs>=1.5.3",
-    "mkdocstrings[python]>=0.24.0",
     "mkdocs-material>=9.5.6",
+    "mkdocstrings[python]>=0.24.0",
+    "mike>=2.0.0",
+    "setuptools>=62.3.3",
+    "markdown-exec>=0.7.0",
+    "mkdocs-redirects>=1.2.0",
+    "mkdocs-version-annotations>=1.0.0",
 ]
 dev = [
     "isort>=5.12.0",
@@ -100,8 +105,13 @@ dev = [
     "pytest>=7.2.2",
     "pytest-cov>=4.1.0",
     "mkdocs>=1.5.3",
-    "mkdocstrings[python]>=0.24.0",
     "mkdocs-material>=9.5.6",
+    "mkdocstrings[python]>=0.24.0",
+    "mike>=2.0.0",
+    "setuptools>=62.3.3",
+    "markdown-exec>=0.7.0",
+    "mkdocs-redirects>=1.2.0",
+    "mkdocs-version-annotations>=1.0.0",
 ]
 
 [tool.isort]