Mercurial > boomslang

annotate docs/Makefile @ 819:80ff3c9187bc pyntnclick

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Rename InteractText to InteractDebugText to better reflect it's aim
author Neil Muller <neil@dip.sun.ac.za>
date Mon, 28 Jan 2013 15:48:31 +0200
parents 3794e7f4093e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
42
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
1 # Makefile for Sphinx documentation
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
2 #
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
3
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
4 # You can set these variables from the command line.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
5 SPHINXOPTS =
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
6 SPHINXBUILD = sphinx-build
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
7 PAPER =
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
8 BUILDDIR = _build
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
9
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
10 # Internal variables.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
11 PAPEROPT_a4 = -D latex_paper_size=a4
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
12 PAPEROPT_letter = -D latex_paper_size=letter
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
13 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
14
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
15 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
16
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
17 help:
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
18 @echo "Please use \`make <target>' where <target> is one of"
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
19 @echo " html to make standalone HTML files"
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
20 @echo " dirhtml to make HTML files named index.html in directories"
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
21 @echo " singlehtml to make a single large HTML file"
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
22 @echo " pickle to make pickle files"
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
23 @echo " json to make JSON files"
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
24 @echo " htmlhelp to make HTML files and a HTML help project"
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
25 @echo " qthelp to make HTML files and a qthelp project"
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
26 @echo " devhelp to make HTML files and a Devhelp project"
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
27 @echo " epub to make an epub"
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
28 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
29 @echo " latexpdf to make LaTeX files and run them through pdflatex"
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
30 @echo " text to make text files"
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
31 @echo " man to make manual pages"
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
32 @echo " changes to make an overview of all changed/added/deprecated items"
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
33 @echo " linkcheck to check all external links for integrity"
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
34 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
35
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
36 clean:
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
37 -rm -rf $(BUILDDIR)/*
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
38
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
39 html:
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
40 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
41 @echo
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
42 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
43
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
44 dirhtml:
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
45 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
46 @echo
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
47 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
48
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
49 singlehtml:
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
50 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
51 @echo
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
52 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
53
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
54 pickle:
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
55 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
56 @echo
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
57 @echo "Build finished; now you can process the pickle files."
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
58
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
59 json:
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
60 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
61 @echo
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
62 @echo "Build finished; now you can process the JSON files."
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
63
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
64 htmlhelp:
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
65 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
66 @echo
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
67 @echo "Build finished; now you can run HTML Help Workshop with the" \
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
68 ".hhp project file in $(BUILDDIR)/htmlhelp."
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
69
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
70 qthelp:
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
71 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
72 @echo
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
73 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
74 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
75 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Boomslang.qhcp"
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
76 @echo "To view the help file:"
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
77 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Boomslang.qhc"
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
78
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
79 devhelp:
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
80 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
81 @echo
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
82 @echo "Build finished."
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
83 @echo "To view the help file:"
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
84 @echo "# mkdir -p $$HOME/.local/share/devhelp/Boomslang"
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
85 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Boomslang"
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
86 @echo "# devhelp"
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
87
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
88 epub:
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
89 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
90 @echo
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
91 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
92
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
93 latex:
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
94 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
95 @echo
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
96 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
97 @echo "Run \`make' in that directory to run these through (pdf)latex" \
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
98 "(use \`make latexpdf' here to do that automatically)."
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
99
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
100 latexpdf:
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
101 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
102 @echo "Running LaTeX files through pdflatex..."
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
103 make -C $(BUILDDIR)/latex all-pdf
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
104 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
105
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
106 text:
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
107 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
108 @echo
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
109 @echo "Build finished. The text files are in $(BUILDDIR)/text."
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
110
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
111 man:
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
112 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
113 @echo
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
114 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
115
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
116 changes:
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
117 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
118 @echo
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
119 @echo "The overview file is in $(BUILDDIR)/changes."
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
120
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
121 linkcheck:
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
122 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
123 @echo
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
124 @echo "Link check complete; look for any errors in the above output " \
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
125 "or in $(BUILDDIR)/linkcheck/output.txt."
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
126
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
127 doctest:
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
128 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
129 @echo "Testing of doctests in the sources finished, look at the " \
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
130 "results in $(BUILDDIR)/doctest/output.txt."