Add Mike for Docs Versioning (#33)

* bump version, add mike * mike pages fun * add mike fun * update readme * mike refinements * add docs to changelog
ADGEfficiency · Jul 1, 2023 · 5565f39 · 5565f39
1 parent 0e63030
commit 5565f39
Show file tree

Hide file tree

Showing 7 changed files with 379 additions and 46 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,2 +1,3 @@
+0.1.2 - add the site API, add documentation.
 0.1.1 - allow Python 3.11.
 0.1.0 - added to pypi.
diff --git a/Makefile b/Makefile
@@ -76,12 +76,22 @@ publish: setup
 	poetry build
 	@poetry config pypi-token.pypi $(PYPI_TOKEN)
 	poetry publish
+	#  TODO publish docs
 
 #  DOCS
-.PHONY: docs docs-build
+.PHONY: docs docs-build mike-deploy
 
 docs: setup-docs
-	cd docs; mkdocs serve; cd ..
+	cd docs; mike serve; cd ..
 
+#  actually not used anymore - we used mike to build & deploy docs
 docs-build: setup-docs
 	cd docs; mkdocs build; cd ..
+
+#  -u = update aliases of this $(VERSION) to latest
+#  -b = branch - aligns with the branch name we build docs off
+#  -r = Github remote
+#  -p = push
+#  TODO - get VERSION from pyproject.toml
+mike-deploy:
+	cd docs; mike deploy $(VERSION) latest -u -b mike-pages -r origin -p
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 
 ---
 
-Documentation: [energypylinear.adgefficiency.com](https://energypylinear.adgefficiency.com)
+Documentation: [energypylinear.adgefficiency.com](https://energypylinear.adgefficiency.com/latest)
 
 ---
 
@@ -107,4 +107,4 @@ $ make test
 
 ## Documentation 
 
-Documentation is hosted at [energypylinear.adgefficiency.com](https://energypylinear.adgefficiency.com).
+Documentation is hosted at [energypylinear.adgefficiency.com](https://energypylinear.adgefficiency.com/latest).
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -1,4 +1,5 @@
 site_name: energy-py-linear
+site_url: https://energypylinear.adgefficiency.com
 repo_url: https://github.com/ADGEfficiency/energy-py-linear
 repo_name: energy-py-linear
 theme:
@@ -63,3 +64,6 @@ nav:
   #   - Blocks: index.md
   #   - Spills: index.md
   #   - Valves: index.md
+extra:
+  version:
+    provider: mike
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -5,3 +5,4 @@ phmdoctest
 pytest
 pillow
 cairosvg
+mike
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "energypylinear"
-version = "0.1.1"
+version = "0.1.2"
 description = "Optimizing energy assets with mixed-integer linear programming."
 authors = ["Adam Green <adam.green@adgefficiency.com>"]
 license = "MIT"
@@ -40,6 +40,10 @@ ipython = "^8.7.0"
 [tool.poetry.group.static.dependencies]
 mypy = "^0.991"
 
+
+[tool.poetry.group.dev.dependencies]
+mike = "^1.1.2"
+
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"