dev: update mkdocs targets to use python virtual environment

practicalli · Sep 29, 2024 · 31c35bf · 31c35bf
1 parent 55b0c09
commit 31c35bf
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,3 +13,4 @@
 ## Changed
 - mkdocs: correct github url for repo and edit link
 - dev: megalinter upgrade to version 8
+- dev: update mkdocs targets to use python virtual environment
diff --git a/Makefile b/Makefile
@@ -11,6 +11,7 @@
 # ------- Makefile Variables --------- #
 # run help if no target specified
 .DEFAULT_GOAL := help
+SHELL := /usr/bin/zsh
 
 # Column the target description is printed from
 HELP-DESCRIPTION-SPACING := 24
@@ -44,17 +45,22 @@ megalinter-upgrade:  ## Upgrade MegaLinter config to latest version
 # ------------------------------------ #
 
 # --- Documentation Generation  ------ #
-docs:  ## Build and run mkdocs in local server
+
+python-venv:  ## Enable Python Virtual Environment for MkDocs
+	$(info --------- Mkdocs Local Server ---------)
+	source ~/.local/venv/bin/activate
+
+docs: ## Build and run mkdocs in local server (python venv)
 	$(info --------- Mkdocs Local Server ---------)
-	$(MKDOCS_SERVER)
+	source ~/.local/venv/bin/activate && $(MKDOCS_SERVER)
 
-docs-changed:  ## Build only changed files and run mkdocs in local server
+docs-changed:  ## Build only changed files and run mkdocs in local server (python venv)
 	$(info --------- Mkdocs Local Server ---------)
-	$(MKDOCS_SERVER) --dirtyreload
+	source ~/.local/venv/bin/activate && $(MKDOCS_SERVER) --dirtyreload
 
-docs-build:  ## Build mkdocs
+docs-build:  ## Build mkdocs (python venv)
 	$(info --------- Mkdocs Local Server ---------)
-	mkdocs build
+	source ~/.local/venv/bin/activate && mkdocs build
 # ------------------------------------ #
 
 # ------------ Help ------------------ #