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) $(SPHINXSOURCE)
16
.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
21
@echo "Please use \`make <target>' where <target> is one of"
22
@echo " html to make standalone HTML files"
23
@echo " dirhtml to make HTML files named index.html in directories"
24
@echo " pickle to make pickle files"
25
@echo " json to make JSON files"
26
@echo " htmlhelp to make HTML files and a HTML help project"
27
@echo " qthelp to make HTML files and a qthelp project"
28
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
29
@echo " changes to make an overview of all changed/added/deprecated items"
30
@echo " linkcheck to check all external links for integrity"
31
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
35
if [ -f .autogenerated ] ; then \
36
cat .autogenerated | xargs rm ; \
41
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
43
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
46
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
48
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
51
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
53
@echo "Build finished; now you can process the pickle files."
56
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
58
@echo "Build finished; now you can process the JSON files."
61
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
63
@echo "Build finished; now you can run HTML Help Workshop with the" \
64
".hhp project file in $(BUILDDIR)/htmlhelp."
67
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
69
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
70
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
71
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/nova.qhcp"
72
@echo "To view the help file:"
73
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/nova.qhc"
76
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
78
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
79
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
80
"run these through (pdf)latex."
83
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
85
@echo "The overview file is in $(BUILDDIR)/changes."
88
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
90
@echo "Link check complete; look for any errors in the above output " \
91
"or in $(BUILDDIR)/linkcheck/output.txt."
94
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
95
@echo "Testing of doctests in the sources finished, look at the " \
96
"results in $(BUILDDIR)/doctest/output.txt."