Makefile

.PHONY: help docs serve_docs install test deploy_docs

DOCS_DIR = docs
GH_REMOTE = $(shell git remote -v | grep "origin.*(fetch)" | grep -E "\S+\\.\S+" -o)
DEPLOY_DOCS_MESSAGE = Build docs

help:
	@echo "Please use 'make <target>' where <target> is one of:"
	@echo "  install     to install the datascience package locally"
	@echo "  test        to run the tests"
	@echo "  docs        to build the docs"
	@echo "  clean_docs  to remove the doc files"
	@echo "  serve_docs  to serve the docs from a local Python server"
	@echo "  deploy_docs to deploy the docs to Github Pages"

install:
	python setup.py develop

test:
	python setup.py test

docs:
	cd $(DOCS_DIR) ; make html

clean_docs:
	cd $(DOCS_DIR) ; make clean

serve_docs:
	cd $(DOCS_DIR)/_build/html ; python -m http.server

deploy_docs:
	rm -rf doc_build

	git clone --quiet --branch=gh-pages $(GH_REMOTE) doc_build
	cp -r docs/_build/html/* doc_build

	cd doc_build && \
		git add -A && \
		git commit -m "$(DEPLOY_DOCS_MESSAGE)" && \
		git push -f $(GH_REMOTE) gh-pages

	rm -rf doc_build