Install mike for mkdocs

GateNLP · Jul 11, 2024 · 6916ceb · 6916ceb
1 parent 86c92d9
commit 6916ceb
Show file tree

Hide file tree

Showing 4 changed files with 106 additions and 2 deletions.
diff --git a/docs/overrides/main.html b/docs/overrides/main.html
@@ -0,0 +1,8 @@
+{% extends "base.html" %}
+
+{% block outdated %}
+  You're viewing an outdated version.
+  <a href="{{ '../' ~ base_url }}">
+    <strong>Click here to go to latest.</strong>
+  </a>
+{% endblock %}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -11,7 +11,11 @@ theme:
     - navigation.footer
   palette:
     primary: 'green'
-
+  custom_dir: docs/overrides
+extra:
+  version:
+    provider: mike
+    alias: true
 
 nav:
   - Home: index.md

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -57,6 +57,7 @@ mkdocs-material = "^9.5.28"
 mkdocstrings = "^0.25.1"
 mkdocstrings-python = "^1.10.5"
 black = "^24.4.2"
+mike = "^2.1.2"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]