1
# Makefile for Sphinx documentation
4
# You can set these variables from the command line.
6
SPHINXBUILD = sphinx-build
12
PAPEROPT_a4 = -D latex_paper_size=a4
13
PAPEROPT_letter = -D latex_paper_size=letter
14
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
17
BUILDI18N = ./build_i18n.py
20
.PHONY: help clean html web pickle htmlhelp latex changes linkcheck i18n
23
@echo "Please use \`make <target>' where <target> is one of"
24
@echo " html to make standalone HTML files"
25
@echo " pickle to make pickle files"
26
@echo " json to make JSON files"
27
@echo " htmlhelp to make HTML files and a HTML help project"
28
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
29
@echo " changes to make an overview over all changed/added/deprecated items"
30
@echo " linkcheck to check all external links for integrity"
31
@echo " i18n LANG=<your_lang> to convert untranslated sources to translatable templates"
37
mkdir -p build/html build/doctrees
38
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
40
cp ./index.php build/html
42
@echo "Build finished. The HTML pages are in build/html."
45
mkdir -p build/pickle build/doctrees
46
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
48
@echo "Build finished; now you can process the pickle files."
53
mkdir -p build/json build/doctrees
54
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) build/json
56
@echo "Build finished; now you can process the JSON files."
59
mkdir -p build/htmlhelp build/doctrees
60
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
62
@echo "Build finished; now you can run HTML Help Workshop with the" \
63
".hhp project file in build/htmlhelp."
66
mkdir -p build/latex build/doctrees
67
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
68
cp texfiles/howto.cls build/latex
70
@echo "Build finished; the LaTeX files are in build/latex."
71
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
74
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
75
@echo "Running LaTeX files through pdflatex..."
76
make -C $(BUILDDIR)/latex all-pdf
77
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
80
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
82
@echo "Build finished. The text files are in $(BUILDDIR)/text."
85
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
87
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
90
mkdir -p build/changes build/doctrees
91
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
93
@echo "The overview file is in build/changes."
96
mkdir -p build/linkcheck build/doctrees
97
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
99
@echo "Link check complete; look for any errors in the above output " \
100
"or in build/linkcheck/output.txt."
106
-rm -rf i18n/*/build/*