Add doc versioning via mike

automl · Sep 11, 2023 · 05a9ea9 · 05a9ea9
1 parent ca8b1c9
commit 05a9ea9
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -27,5 +27,11 @@ jobs:
         with:
           key: ${{ github.ref }}
           path: .cache
+      - uses: SebRollen/[email protected]
+        id: read_toml
+        with:
+          file: 'pyproject.toml'
+          field: 'project.version'
       - run: pip install ".[dev]"
-      - run: mkdocs gh-deploy --force
+      - run: mike deploy --push --update-aliases ${{ steps.read_toml.outputs.value }} latest
+      - run: mike set-default --push latest
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -100,4 +100,8 @@ plugins:
             members_order: "source"
             show_signature: true
             separate_signature: false
-            show_signature_annotations: false
+            show_signature_annotations: false
+
+extra:
+  version:
+    provider: mike
diff --git a/pyproject.toml b/pyproject.toml
@@ -46,6 +46,7 @@ dev = [
   "mkdocs-material",
   "mkdocstrings[python]",
   "markdown-exec[ansi]",
+  "mike",
   # Others
   "ruff",
   "black",