Makefile

default: help

PYTHON_VERSION=3
VENV_DIR=venv
SHELL := /bin/bash

.PHONY: install
install: ## Creates a development environment and install the required dependencies.
	python$(PYTHON_VERSION) -m venv $(VENV_DIR)
	$(VENV_DIR)/bin/pip install --upgrade pip
	$(VENV_DIR)/bin/pip install --upgrade pip-tools
	$(VENV_DIR)/bin/pip-compile --upgrade requirements.in
	$(VENV_DIR)/bin/pip-sync requirements.txt

.PHONY: update-venv
update-venv: ## Updates the development environment.
	$(VENV_DIR)/bin/pip install --upgrade pip
	$(VENV_DIR)/bin/pip-compile --upgrade requirements.in
	$(VENV_DIR)/bin/pip-sync requirements.txt

.PHONY: serve
serve: ## Starts a lightweight development Web server on the local machine.
	$(VENV_DIR)/bin/mkdocs serve --dev-addr '127.0.0.1:8000'

.PHONY: build
build: ## Builds the documentation.
	$(VENV_DIR)/bin/mkdocs build

.PHONY: quickstart
quickstart: install serve ## Quicktart demo app.

.PHONY: install-linter
install-linter: ## install markdown-lint
	npm install markdownlint-cli2 --save-dev

.PHONY: install-linkcheck
install-linkcheck:  ## install Link checker
	npm install --save-dev markdown-link-check

.PHONY: lint
lint: ## Lint all .md files in the src directory
	npx markdownlint-cli2 "src/**/*.md" "\#node_modules" --config .markdownlint.json

.PHONY: lint-fix
lint-fix: ## Lint all .md files in the src directory
	npx markdownlint-cli2 "src/**/*.md" "\#node_modules" --config .markdownlint.json --fix

.PHONY: linkcheck
linkcheck: ## check all files for broken links
	find ./src/ -name \*.md -print0 | xargs -0 -n1 markdown-link-check -c mlc_config.json -q

.PHONY: check
check: lint linkcheck ## Run Github Action validation

.PHONY: help
help: ## Lists all available commands.
	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'