1 # Makefile for Sphinx documentation
4 # You can set these variables from the command line.
6 SPHINXBUILD = sphinx-build
11 PAPEROPT_a4 = -D latex_paper_size=a4
12 PAPEROPT_letter = -D latex_paper_size=letter
13 ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SRCDIR)
16 WWW_UPLOAD_URI = elrond:/home/hanke/public_html/archive
20 .PHONY: help clean html web pickle htmlhelp latex changes linkcheck
32 mkdir -p build/html build/doctrees
33 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
35 @echo "Build finished. The HTML pages are in build/html."
38 mkdir -p build/pickle build/doctrees
39 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
41 @echo "Build finished; now you can process the pickle files."
46 mkdir -p build/json build/doctrees
47 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) build/json
49 @echo "Build finished; now you can process the JSON files."
52 mkdir -p build/htmlhelp build/doctrees
53 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
55 @echo "Build finished; now you can run HTML Help Workshop with the" \
56 ".hhp project file in build/htmlhelp."
59 mkdir -p build/latex build/doctrees
60 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
62 @echo "Build finished; the LaTeX files are in build/latex."
63 @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
64 "run these through (pdf)latex."
67 mkdir -p build/changes build/doctrees
68 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
70 @echo "The overview file is in build/changes."
73 mkdir -p build/linkcheck build/doctrees
74 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
76 @echo "Link check complete; look for any errors in the above output " \
77 "or in build/linkcheck/output.txt."
85 rsync -rvzlhp --delete --chmod=Dg+s,g+rw $(WWW_DIR) $(WWW_UPLOAD_URI)