Set up to use mike

SWE-agent · Dec 6, 2024 · 11e18f5 · 11e18f5
1 parent 3740095
commit 11e18f5
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/.github/workflows/build-docs.yaml b/.github/workflows/build-docs.yaml
@@ -40,4 +40,4 @@ jobs:
         run: mkdocs build
       - name: Build + Deploy Documentation
         if: github.ref == 'refs/heads/main'
-        run: mkdocs gh-deploy --force
+        run: mike deploy --push 1.0 latest
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -74,6 +74,9 @@ plugins:
    - glightbox
    - search
    - include-markdown
+   - mike:
+      canonical_version: latest
+      version_selector: true
    - mkdocstrings:
       default_handler: python
       handlers:
@@ -99,4 +102,7 @@ repo_url: https://github.com/SWE-agent/SWE-ReX
 repo_name: SWE-agent/SWE-ReX
 edit_uri: edit/main/docs/
 extra_css:
-  - css/mkdocstrings.css
+  - css/mkdocstrings.css
+extra:
+  version:
+    provider: mike
diff --git a/pyproject.toml b/pyproject.toml
@@ -40,6 +40,7 @@ dependencies = [
 
 [project.optional-dependencies]
 dev = [
+    "mike",
     "mkdocs-material",
     "mkdocs-glightbox",
     "mkdocs-include-markdown-plugin",