byteflow / Makefile

# Makefile for Sphinx documentation

# You can set these variables from the command line.
SPHINXBUILD   = sphinx-build
PAPER         =

# Internal variables.
PAPEROPT_a4     = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS   = -d doc-build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) docs

.PHONY: help clean html web htmlhelp latex changes linkcheck

	@echo "Please use \`make <target>' where <target> is one of"
	@echo "  html      to make standalone HTML files"
	@echo "  web       to make files usable by Sphinx.web"
	@echo "  htmlhelp  to make HTML files and a HTML help project"
	@echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
	@echo "  changes   to make an overview over all changed/added/deprecated items"
	@echo "  linkcheck to check all external links for integrity"
	@echo "  read      to open html version in browser"

	-rm -rf doc-build/*

	mkdir -p doc-build/html doc-build/doctrees
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) doc-build/html
	@echo "Build finished. The HTML pages are in doc-build/html."

read: html
	open doc-build/html/index.html

	mkdir -p doc-build/web doc-build/doctrees
	$(SPHINXBUILD) -b web $(ALLSPHINXOPTS) doc-build/web
	@echo "Build finished; now you can run"
	@echo "  python -m sphinx.web doc-build/web"
	@echo "to start the server."

	mkdir -p doc-build/htmlhelp doc-build/doctrees
	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) doc-build/htmlhelp
	@echo "Build finished; now you can run HTML Help Workshop with the" \
	      ".hhp project file in doc-build/htmlhelp."

	mkdir -p doc-build/latex doc-build/doctrees
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) doc-build/latex
	@echo "Build finished; the LaTeX files are in doc-build/latex."
	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
	      "run these through (pdf)latex."

	mkdir -p doc-build/changes doc-build/doctrees
	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) doc-build/changes
	@echo "The overview file is in doc-build/changes."

	mkdir -p doc-build/linkcheck doc-build/doctrees
	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) doc-build/linkcheck
	@echo "Link check complete; look for any errors in the above output " \
	      "or in doc-build/linkcheck/output.txt."