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) .
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 " pdf to make PDF document"
21
@echo " dirhtml to make HTML files named index.html in directories"
22
@echo " pickle to make pickle files"
23
@echo " json to make JSON files"
24
@echo " htmlhelp to make HTML files and a HTML help project"
25
@echo " qthelp to make HTML files and a qthelp project"
26
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
27
@echo " changes to make an overview of all changed/added/deprecated items"
28
@echo " linkcheck to check all external links for integrity"
29
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
35
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
37
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
40
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
42
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
45
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
47
@echo "Build finished; now you can process the pickle files."
50
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
52
@echo "Build finished; now you can process the JSON files."
55
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
57
@echo "Build finished; now you can run HTML Help Workshop with the" \
58
".hhp project file in $(BUILDDIR)/htmlhelp."
61
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
63
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
64
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
65
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/dulwich.qhcp"
66
@echo "To view the help file:"
67
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/dulwich.qhc"
70
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
72
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
73
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
74
"run these through (pdf)latex."
77
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
79
@echo "The overview file is in $(BUILDDIR)/changes."
82
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
84
@echo "Link check complete; look for any errors in the above output " \
85
"or in $(BUILDDIR)/linkcheck/output.txt."
88
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
89
@echo "Testing of doctests in the sources finished, look at the " \
90
"results in $(BUILDDIR)/doctest/output.txt."
93
$(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) $(BUILDDIR)/pdf
95
@echo "Build finished. The PDF files are in $(BUILDDIR)/pdf."
added
removed
docs/Makefile
