Makefile

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

.PHONY: setup
setup:  ## Set up the local development environment
	poetry install
	poetry run pre-commit install

.PHONY: test
test:  ## Run the tests, but only for current Python version
	poetry run tox -e py

.PHONY: test-all
test-all:  ## Run the tests for all relevant Python version
	poetry run tox

.PHONY: publish
publish:  ## Build & publish the new version
	poetry build
	poetry publish

.PHONY: format
format:  ## Autoformat all files in the repo. WARNING: changes files in-place
	poetry run black toml_sort tests
	poetry run isort toml_sort tests
	poetry run docformatter --recursive --in-place toml_sort tests

.PHONY: build-docs
build-docs: docs/autogen-requirements.txt  ## Build the Sphinx docs
	sphinx-build -M html docs docs/_build

.PHONY: serve-docs
serve-docs: build-docs  ## Simple development server for Sphinx docs
	@echo "Serving documentation locally."
	@echo "Open browser with 'make open-docs'"
	@find docs toml_sort | entr -ps "$(MAKE) build-docs"

.PHONY: open-docs
open-docs:  ## Open Sphinx docs index in a browser
	gio open docs/_build/html/index.html

.PHONY: clean-docs
clean-docs:  ## Clean the docs
	rm -r docs/_build

docs/autogen-requirements.txt:  poetry.lock ## Autogenerate the requirements.txt
	poetry export --dev --format requirements.txt --output $@ && git add $@