# Makefile for Sphinx documentation
# You can set these variables from the command line.
SPHINXBUILD = python ../sphinx-build.py
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) \
$(SPHINXOPTS) $(O) .
.PHONY: help clean html dirhtml pickle htmlhelp qthelp latex changes linkcheck doctest man
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files called index.html in directories"
@echo " pickle to make pickle files"
@echo " json to make json files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " epub to make an epub file"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " man to make manual pages"
@echo " changes to make an overview over all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
-rm -rf _build/*
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
@echo "Build finished. The HTML pages are in _build/html."
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml
@echo "Build finished. The HTML pages are in _build/dirhtml."
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) _build/singlehtml
@echo "Build finished. The HTML page is in _build/singlehtml."
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) _build/text
@echo "Build finished."
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) _build/man
@echo "Build finished."
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
mkdir -p _build/json _build/doctrees
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in _build/htmlhelp."
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp
@echo "Build finished; now you can run qcollectiongenerator with the" \
".qhcp project file in build/qthelp."
@echo "# qcollectiongenerator _build/qthelp/Sphinx.qhcp"
@echo "To view the help collection:"
@echo "# assistant -collectionFile _build/qthelp/Sphinx.qhc"
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) _build/epub
@echo "Build finished. The epub file is in _build/epub."
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
@echo "Build finished; the LaTeX files are in _build/latex."
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
"run these through (pdf)latex."
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
@echo "The overview file is in _build/changes."
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
@echo "Link check complete; look for any errors in the above output " \
"or in _build/linkcheck/output.txt."
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest