annotate docs/Makefile @ 458:a55e0f05f745

synch
author cat@eee
date Wed, 17 Feb 2010 23:20:20 -0500
parents
children
rev   line source
458
cat@eee
parents:
diff changeset
1 # Makefile for Sphinx documentation
cat@eee
parents:
diff changeset
2 #
cat@eee
parents:
diff changeset
3
cat@eee
parents:
diff changeset
4 # You can set these variables from the command line.
cat@eee
parents:
diff changeset
5 SPHINXOPTS =
cat@eee
parents:
diff changeset
6 SPHINXBUILD = sphinx-build
cat@eee
parents:
diff changeset
7 PAPER =
cat@eee
parents:
diff changeset
8 BUILDDIR = build
cat@eee
parents:
diff changeset
9
cat@eee
parents:
diff changeset
10 # Internal variables.
cat@eee
parents:
diff changeset
11 PAPEROPT_a4 = -D latex_paper_size=a4
cat@eee
parents:
diff changeset
12 PAPEROPT_letter = -D latex_paper_size=letter
cat@eee
parents:
diff changeset
13 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
cat@eee
parents:
diff changeset
14
cat@eee
parents:
diff changeset
15 .PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
cat@eee
parents:
diff changeset
16
cat@eee
parents:
diff changeset
17 help:
cat@eee
parents:
diff changeset
18 @echo "Please use \`make <target>' where <target> is one of"
cat@eee
parents:
diff changeset
19 @echo " html to make standalone HTML files"
cat@eee
parents:
diff changeset
20 @echo " dirhtml to make HTML files named index.html in directories"
cat@eee
parents:
diff changeset
21 @echo " pickle to make pickle files"
cat@eee
parents:
diff changeset
22 @echo " json to make JSON files"
cat@eee
parents:
diff changeset
23 @echo " htmlhelp to make HTML files and a HTML help project"
cat@eee
parents:
diff changeset
24 @echo " qthelp to make HTML files and a qthelp project"
cat@eee
parents:
diff changeset
25 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
cat@eee
parents:
diff changeset
26 @echo " changes to make an overview of all changed/added/deprecated items"
cat@eee
parents:
diff changeset
27 @echo " linkcheck to check all external links for integrity"
cat@eee
parents:
diff changeset
28 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
cat@eee
parents:
diff changeset
29
cat@eee
parents:
diff changeset
30 clean:
cat@eee
parents:
diff changeset
31 -rm -rf $(BUILDDIR)/*
cat@eee
parents:
diff changeset
32
cat@eee
parents:
diff changeset
33 html:
cat@eee
parents:
diff changeset
34 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
cat@eee
parents:
diff changeset
35 @echo
cat@eee
parents:
diff changeset
36 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
cat@eee
parents:
diff changeset
37
cat@eee
parents:
diff changeset
38 dirhtml:
cat@eee
parents:
diff changeset
39 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
cat@eee
parents:
diff changeset
40 @echo
cat@eee
parents:
diff changeset
41 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
cat@eee
parents:
diff changeset
42
cat@eee
parents:
diff changeset
43 pickle:
cat@eee
parents:
diff changeset
44 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
cat@eee
parents:
diff changeset
45 @echo
cat@eee
parents:
diff changeset
46 @echo "Build finished; now you can process the pickle files."
cat@eee
parents:
diff changeset
47
cat@eee
parents:
diff changeset
48 json:
cat@eee
parents:
diff changeset
49 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
cat@eee
parents:
diff changeset
50 @echo
cat@eee
parents:
diff changeset
51 @echo "Build finished; now you can process the JSON files."
cat@eee
parents:
diff changeset
52
cat@eee
parents:
diff changeset
53 htmlhelp:
cat@eee
parents:
diff changeset
54 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
cat@eee
parents:
diff changeset
55 @echo
cat@eee
parents:
diff changeset
56 @echo "Build finished; now you can run HTML Help Workshop with the" \
cat@eee
parents:
diff changeset
57 ".hhp project file in $(BUILDDIR)/htmlhelp."
cat@eee
parents:
diff changeset
58
cat@eee
parents:
diff changeset
59 qthelp:
cat@eee
parents:
diff changeset
60 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
cat@eee
parents:
diff changeset
61 @echo
cat@eee
parents:
diff changeset
62 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
cat@eee
parents:
diff changeset
63 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
cat@eee
parents:
diff changeset
64 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/sqlpython.qhcp"
cat@eee
parents:
diff changeset
65 @echo "To view the help file:"
cat@eee
parents:
diff changeset
66 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/sqlpython.qhc"
cat@eee
parents:
diff changeset
67
cat@eee
parents:
diff changeset
68 latex:
cat@eee
parents:
diff changeset
69 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
cat@eee
parents:
diff changeset
70 @echo
cat@eee
parents:
diff changeset
71 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
cat@eee
parents:
diff changeset
72 @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
cat@eee
parents:
diff changeset
73 "run these through (pdf)latex."
cat@eee
parents:
diff changeset
74
cat@eee
parents:
diff changeset
75 changes:
cat@eee
parents:
diff changeset
76 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
cat@eee
parents:
diff changeset
77 @echo
cat@eee
parents:
diff changeset
78 @echo "The overview file is in $(BUILDDIR)/changes."
cat@eee
parents:
diff changeset
79
cat@eee
parents:
diff changeset
80 linkcheck:
cat@eee
parents:
diff changeset
81 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
cat@eee
parents:
diff changeset
82 @echo
cat@eee
parents:
diff changeset
83 @echo "Link check complete; look for any errors in the above output " \
cat@eee
parents:
diff changeset
84 "or in $(BUILDDIR)/linkcheck/output.txt."
cat@eee
parents:
diff changeset
85
cat@eee
parents:
diff changeset
86 doctest:
cat@eee
parents:
diff changeset
87 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
cat@eee
parents:
diff changeset
88 @echo "Testing of doctests in the sources finished, look at the " \
cat@eee
parents:
diff changeset
89 "results in $(BUILDDIR)/doctest/output.txt."