1 # Makefile for Sphinx documentation
4 # You can set these variables from the command line.
6 SPHINXBUILD = sphinx-build
10 PAPEROPT_a4 = -D latex_paper_size=a4
11 PAPEROPT_letter = -D latex_paper_size=letter
12 ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
14 .PHONY: help clean html web pickle htmlhelp latex changes linkcheck
17 @echo "Please use \`make <target>' where <target> is one of"
18 @echo " html to make standalone HTML files"
19 @echo " pickle to make pickle files"
20 @echo " json to make JSON files"
21 @echo " htmlhelp to make HTML files and a HTML help project"
22 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
23 @echo " changes to make an overview over all changed/added/deprecated items"
24 @echo " linkcheck to check all external links for integrity"
30 mkdir -p build/html build/doctrees
31 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
33 @echo "Build finished. The HTML pages are in build/html."
36 mkdir -p build/pickle build/doctrees
37 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
39 @echo "Build finished; now you can process the pickle files."
44 mkdir -p build/json build/doctrees
45 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) build/json
47 @echo "Build finished; now you can process the JSON files."
50 mkdir -p build/htmlhelp build/doctrees
51 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
53 @echo "Build finished; now you can run HTML Help Workshop with the" \
54 ".hhp project file in build/htmlhelp."
57 mkdir -p build/latex build/doctrees
58 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
60 @echo "Build finished; the LaTeX files are in build/latex."
61 @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
62 "run these through (pdf)latex."
65 mkdir -p build/changes build/doctrees
66 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
68 @echo "The overview file is in build/changes."
71 mkdir -p build/linkcheck build/doctrees
72 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
74 @echo "Link check complete; look for any errors in the above output " \
75 "or in build/linkcheck/output.txt."