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
$(BUILDDIR
)/doctrees
$(PAPEROPT_
$(PAPER
)) $(SPHINXOPTS
) source
15 .PHONY
: help
clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
18 @echo
"Please use \`make <target>' where <target> is one of"
19 @echo
" html to make standalone HTML files"
20 @echo
" dirhtml to make HTML files named index.html in directories"
21 @echo
" pickle to make pickle files"
22 @echo
" json to make JSON files"
23 @echo
" htmlhelp to make HTML files and a HTML help project"
24 @echo
" qthelp to make HTML files and a qthelp project"
25 @echo
" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
26 @echo
" changes to make an overview of all changed/added/deprecated items"
27 @echo
" linkcheck to check all external links for integrity"
28 @echo
" doctest to run all doctests embedded in the documentation (if enabled)"
34 $(SPHINXBUILD
) -b html
$(ALLSPHINXOPTS
) $(BUILDDIR
)/html
36 @echo
"Build finished. The HTML pages are in $(BUILDDIR)/html."
39 $(SPHINXBUILD
) -b dirhtml
$(ALLSPHINXOPTS
) $(BUILDDIR
)/dirhtml
41 @echo
"Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
44 $(SPHINXBUILD
) -b pickle
$(ALLSPHINXOPTS
) $(BUILDDIR
)/pickle
46 @echo
"Build finished; now you can process the pickle files."
49 $(SPHINXBUILD
) -b json
$(ALLSPHINXOPTS
) $(BUILDDIR
)/json
51 @echo
"Build finished; now you can process the JSON files."
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 $(SPHINXBUILD
) -b qthelp
$(ALLSPHINXOPTS
) $(BUILDDIR
)/qthelp
62 @echo
"Build finished; now you can run "qcollectiongenerator
" with the" \
63 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
64 @echo
"# qcollectiongenerator $(BUILDDIR)/qthelp/Gallium.qhcp"
65 @echo
"To view the help file:"
66 @echo
"# assistant -collectionFile $(BUILDDIR)/qthelp/Gallium.qhc"
69 $(SPHINXBUILD
) -b latex
$(ALLSPHINXOPTS
) $(BUILDDIR
)/latex
71 @echo
"Build finished; the LaTeX files are in $(BUILDDIR)/latex."
72 @echo
"Run \`make all-pdf' or \`make all-ps' in that directory to" \
73 "run these through (pdf)latex."
76 $(SPHINXBUILD
) -b changes
$(ALLSPHINXOPTS
) $(BUILDDIR
)/changes
78 @echo
"The overview file is in $(BUILDDIR)/changes."
81 $(SPHINXBUILD
) -b linkcheck
$(ALLSPHINXOPTS
) $(BUILDDIR
)/linkcheck
83 @echo
"Link check complete; look for any errors in the above output " \
84 "or in $(BUILDDIR)/linkcheck/output.txt."
87 $(SPHINXBUILD
) -b doctest
$(ALLSPHINXOPTS
) $(BUILDDIR
)/doctest
88 @echo
"Testing of doctests in the sources finished, look at the " \
89 "results in $(BUILDDIR)/doctest/output.txt."