diff --git a/CHANGELOG.md b/CHANGELOG.md index fcdc39a..b90ebbb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,6 +19,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) - make: `git-sr` and `git-status` to check status of all repositories - os: hyprland configuration files - kitty: example transparent_background options for linux +- make: mkdocs and python virtual environment tasks ### Changed - git: restructure multiple configs, using relative include file paths diff --git a/Makefile b/Makefile index 3d61624..4fd4d28 100644 --- a/Makefile +++ b/Makefile @@ -38,6 +38,8 @@ HELP-DESCRIPTION-SPACING := 24 # Tool variables # MEGALINTER_RUNNER := npx mega-linter-runner --flavor documentation --env "'MEGALINTER_CONFIG=.github/config/megalinter.yaml'" --remove-container MEGALINTER_RUNNER := npx mega-linter-runner --flavor java --env "'MEGALINTER_CONFIG=.github/config/megalinter.yaml'" --remove-container + +MKDOCS_SERVER := mkdocs serve --dev-addr localhost:7777 # -------------------------------------- # # -- Help ------------------------------ # @@ -181,10 +183,22 @@ git-status: ## status details of git repos under current directory mgitstatus # -------------------------------------- # -# -- Documentation Generation ---------- # -docs: ## Run mkdocs server - $(info -- Mkdocs Local Server -------------------) - mkdocs serve --dev-addr localhost:7777 +# --- Documentation Generation -------- # +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 -----------------) + source ~/.local/venv/bin/activate && $(MKDOCS_SERVER) + +docs-changed: ## Build only changed files and run mkdocs in local server (python venv) + $(info -- Mkdocs Local Server -----------------) + source ~/.local/venv/bin/activate && $(MKDOCS_SERVER) --dirtyreload + +docs-build: ## Build mkdocs (python venv) + $(info -- Mkdocs Local Server -----------------) + source ~/.local/venv/bin/activate && mkdocs build # -------------------------------------- # # ------- Docker Containers ------------ #