From 0676c65e06d9ec1e02516bf0f2b3267bfe933231 Mon Sep 17 00:00:00 2001 From: Derek Schaller Date: Sat, 17 Feb 2018 08:47:10 -0800 Subject: [PATCH] add documentation to makefile --- Makefile | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 40f13f29..255b55af 100644 --- a/Makefile +++ b/Makefile @@ -1,12 +1,21 @@ -.PHONY: docs +.PHONY: help ## Print this help +help: + @grep -E '^\.PHONY: [a-zA-Z_-]+ .*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = "(: |##)"}; {printf "\033[36m%-30s\033[0m %s\n", $$2, $$3}' +.PHONY: run-tests ## Run unit tests run-tests: pipenv run pytest tests + +.PHONY: init ## Initialize pipenv for development init: python setup.py install pipenv install --dev + +.PHONY: docs ## Generate documentation docs: cd docs && make html + +.PHONY: ## Generate man documentation man: cd docs && make man mv docs/_build/man/pipenv.1 pipenv/pipenv.1