Add mike doc versioning support

Author: analog-cbarber

Makefile

@@ -176,6 +176,23 @@ showdoc: site/index.html
 
 showdocs: showdoc
 
+doc-deploy:
+	$(CONDA_RUN) mike deploy -F $(MKDOC_CONFIG) -u $(VERSION) latest
+	$(CONDA_RUN) mike set-default -F $(MKDOC_CONFIG) latest
+
+mike-deploy: doc-deploy
+mike-build: doc-deploy
+
+doc-push:
+	git push origin gh-pages
+
+doc-upload: doc-push
+
+doc-serve-all:
+	$(CONDA_RUN) mike serve -F $(MKDOC_CONFIG)
+
+mike-serve: doc-serve-all
+
 check-upload:
 	$(CONDA_RUN) twine check $(WHEEL_FILE)
 

environment.yml

@@ -17,8 +17,8 @@ dependencies:
   - mkdocs-material >=8.2
   - beautifulsoup4 >=4.12
   # documentation
-  - black
-  - mkdocs >=1.3.0
-  - pymdown-extensions
-  - mkdocs-material >=8.2
+  - black >=23.7
+  - mike >=1.1,<2.0
+  - mkdocs >=1.5.0,<2.0
+  - mkdocs-material >=9.1
   - linkchecker >=10.2.1

mkdocs.yml

@@ -46,6 +46,12 @@ theme:
       icon: material/weather-night
       name: Switch to light mode
 
+extra:
+  generator: false
+  version:
+    provider: mike
+    default: stable
+
 markdown_extensions:
 - admonition
 - pymdownx.snippets:
@@ -56,6 +62,12 @@ markdown_extensions:
 
 plugins:
 - search
+- mike:
+    # These fields are all optional; the defaults are as below...
+    canonical_version: stable
+    version_selector: true
+    css_dir: css
+    javascript_dir: js
 - mkdocstrings:
     default_handler: python_xref
     handlers: