1
# You can set these variables from the command line.
3
SPHINXBUILD = sphinx-build
7
PAPEROPT_a4 = -D latex_paper_size=a4
8
PAPEROPT_letter = -D latex_paper_size=letter
9
ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
11
.PHONY: help clean html htmlhelp latex changes coverage
14
@echo "Please use \`make <target>' where <target> is one of"
15
@echo " html to make standalone HTML files"
16
@echo " htmlhelp to make HTML files and a HTML help project"
17
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
18
@echo " changes to make an overview over all changed/added/deprecated items"
19
@echo " coverage to check documentation coverage for library and C API"
25
mkdir -p _build/html _build/doctrees
26
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
28
@echo "Build finished. The HTML pages are in _build/html."
31
mkdir -p _build/latex _build/doctrees
32
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
34
@echo "Build finished; the LaTeX files are in _build/latex."
35
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
36
"run these through (pdf)latex."
39
mkdir -p _build/htmlhelp _build/doctrees
40
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
42
@echo "Build finished; now you can run HTML Help Workshop with the" \
43
".hhp project file in _build/htmlhelp."
46
mkdir -p _build/changes _build/doctrees
47
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
49
@echo "The overview file is in _build/changes."
52
mkdir -p _build/coverage _build/doctrees
53
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) _build/coverage
55
@echo "Coverage finished; see _build/coverage/python.txt"