pin docs dependencies & fix docs override

sonal-chauhan · May 20, 2021 · 35ec0b8 · 35ec0b8
1 parent 07a29df
commit 35ec0b8
Show file tree

Hide file tree

Showing 5 changed files with 458 additions and 43 deletions.
diff --git a/Makefile b/Makefile
@@ -79,9 +79,17 @@ else
 CONTROLLER_GEN=$(shell which controller-gen)
 endif
 
+# preview docs
+docs-preview: docs-dependencies
+	pipenv run mkdocs serve
+
 # publish the versioned docs using mkdocs mike util
-docs-publish:
-	mike deploy v2.0 latest -p
+docs-publish: docs-dependencies
+	pipenv run mike deploy v2.2 latest -p --update-aliases
+
+# install dependencies needed to preview and publish docs
+docs-dependencies:
+	pipenv install --dev
 
 lint:
 	echo "TODO"

diff --git a/Pipfile b/Pipfile
@@ -0,0 +1,14 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+
+[dev-packages]
+mkdocs = "==1.1.2"
+mkdocs-material = "==7.1.5"
+mike = "==1.0.0"
+
+[requires]
+python_version = "3.9"