mike versioning

Author: SpectraL519

.gitignore

@@ -9,6 +9,7 @@
 
 # documentation files
 documentation/
+site/
 
 # python temporary files
 **/__pycache__/

Makefile

@@ -1,13 +1,17 @@
+# Default to 'dev' if TAGS is not specified on the command line
+TAGS ?= dev
+
 .PHONY: docs serve-docs clean-docs clean
 
 docs:
-	@echo "==> Building MkDocs documentation..."
-	uv run mkdocs build
-	@echo "==> Documentation build complete. Output is in site/"
+	@echo "==> Deploying MkDocs documentation locally via mike (Tags: $(TAGS))..."
+	uv run mike deploy $(TAGS)
+	@echo "==> Documentation deployed to local gh-pages branch."
+# Example usage: `make docs TAGS="v2.0.0 latest --update-aliases"`
 
 serve-docs:
-	@echo "==> Serving MkDocs documentation locally..."
-	uv run mkdocs serve
+	@echo "==> Serving versioned MkDocs documentation locally via mike..."
+	uv run mike serve
 
 clean-docs:
 	@echo "==> Cleaning documentation build directories..."

mkdocs.yml

@@ -89,3 +89,8 @@ extra_javascript:
 extra_css:
   - style/logo.css
   - style/theme.css
+
+extra:
+  version:
+    provider: mike
+    default: "latest"

pyproject.toml

@@ -5,6 +5,7 @@ description = "Add your description here"
 readme = "README.md"
 requires-python = ">=3.14"
 dependencies = [
+    "mike>=2.2.0",
     "mkdocs>=1.6.1",
     "mkdocs-callouts>=1.16.0",
     "mkdocs-include-markdown-plugin>=7.2.2",