1 # Makefile for Sphinx documentation
7 # You can set these variables from the command line.
9 SPHINXBUILD = sphinx-build
13 PAPEROPT_a4 = -D latex_paper_size=a4
14 PAPEROPT_letter = -D latex_paper_size=letter
15 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
17 .PHONY: help clean html web pickle htmlhelp latex changes linkcheck
20 @echo "Please use \`make <target>' where <target> is one of"
21 @echo " html to make standalone HTML files"
22 @echo " pickle to make pickle files"
23 @echo " json to make JSON files"
24 @echo " htmlhelp to make HTML files and a HTML help project"
25 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
26 @echo " changes to make an overview over all changed/added/deprecated items"
27 @echo " linkcheck to check all external links for integrity"
33 mkdir -p $(BUILDDIR)/html $(BUILDDIR)/doctrees
34 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
36 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
39 mkdir -p $(BUILDDIR)/pickle $(BUILDDIR)/doctrees
40 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
42 @echo "Build finished; now you can process the pickle files."
47 mkdir -p $(BUILDDIR)/json $(BUILDDIR)/doctrees
48 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
50 @echo "Build finished; now you can process the JSON files."
53 mkdir -p $(BUILDDIR)/htmlhelp $(BUILDDIR)/doctrees
54 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
56 @echo "Build finished; now you can run HTML Help Workshop with the" \
57 ".hhp project file in $(BUILDDIR)/htmlhelp."
60 mkdir -p $(BUILDDIR)/latex $(BUILDDIR)/doctrees
61 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
63 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
64 @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
65 "run these through (pdf)latex."
68 mkdir -p $(BUILDDIR)/changes $(BUILDDIR)/doctrees
69 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
71 @echo "The overview file is in $(BUILDDIR)/changes."
74 mkdir -p $(BUILDDIR)/linkcheck $(BUILDDIR)/doctrees
75 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
77 @echo "Link check complete; look for any errors in the above output " \
78 "or in $(BUILDDIR)/linkcheck/output.txt."