mirror of https://github.com/enpaul/keyosk.git
53 lines
1.6 KiB
Makefile
53 lines
1.6 KiB
Makefile
# Keyosk makefile for building and deployment prep
|
|
|
|
VERSION ?= $(shell cat pyproject.toml | grep "^version =" | cut -d "\"" -f 2)
|
|
DOC_FORMAT ?= html
|
|
DOC_OPTIONS ?=
|
|
DOC_SOURCEDIR = ./docs
|
|
DOC_BUILDDIR = ./docs/_build
|
|
DOC_PROJECT = keyosk
|
|
DOCKER_CONTAINER = keyosk
|
|
|
|
.PHONY: help docs
|
|
# Put it first so that "make" without argument is like "make help"
|
|
# Shamelessly lifted from here:
|
|
# https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
|
|
help: ## List Makefile targets
|
|
$(info Makefile documentation)
|
|
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-10s\033[0m %s\n", $$1, $$2}'
|
|
|
|
tox:
|
|
poetry run tox
|
|
|
|
clean-tox:
|
|
rm -rf ./.mypy_cache
|
|
rm -rf ./.tox
|
|
rm -f .coverage
|
|
|
|
clean-py:
|
|
rm -rf ./dist
|
|
rm -rf ./build
|
|
rm -rf ./*/__pycache__
|
|
rm -rf ./*.egg-info
|
|
|
|
clean-docs:
|
|
rm -rf $(DOC_BUILDDIR)
|
|
rm -f $(DOC_SOURCEDIR)/$(DOC_PROJECT)*.rst
|
|
rm -f $(DOC_SOURCEDIR)/modules.rst
|
|
|
|
clean: clean-tox clean-py clean-docs; ## Clean up all temp build/cache files and directories
|
|
|
|
wheel: ## Build Python binary wheel package for distribution
|
|
poetry build --format wheel
|
|
|
|
source: ## Build Python source package for distribution
|
|
poetry build --format sdist
|
|
|
|
build: clean-py tox; ## Test and build python distributions
|
|
poetry build
|
|
|
|
docs: clean-docs ## Generate sphinx documentation, provide `DOC_FORMAT` to override default format of "html"
|
|
poetry run sphinx-apidoc -o "${DOC_SOURCEDIR}" "${DOC_PROJECT}"
|
|
rm $(DOC_SOURCEDIR)/modules.rst
|
|
poetry run sphinx-build -M $(DOC_FORMAT) "$(DOC_SOURCEDIR)" "$(DOC_BUILDDIR)" $(DOC_OPTIONS) $(0)
|