annotate doc/Makefile @ 299:674789d9ff37

Added a doc
author Windel Bouwman
date Sun, 01 Dec 2013 18:37:23 +0100
parents ea93e0a7a31e
children
rev   line source
273
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
1 # Makefile for Sphinx documentation
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
2 #
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
3
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
4 # You can set these variables from the command line.
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
5 SPHINXOPTS =
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
6 SPHINXBUILD = sphinx-build
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
7 PAPER =
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
8 BUILDDIR = _build
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
9
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
10 # Internal variables.
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
11 PAPEROPT_a4 = -D latex_paper_size=a4
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
12 PAPEROPT_letter = -D latex_paper_size=letter
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
13 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
14 # the i18n builder cannot share the environment and doctrees with the others
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
15 I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
16
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
17 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
18
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
19 help:
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
20 @echo "Please use \`make <target>' where <target> is one of"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
21 @echo " html to make standalone HTML files"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
22 @echo " dirhtml to make HTML files named index.html in directories"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
23 @echo " singlehtml to make a single large HTML file"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
24 @echo " pickle to make pickle files"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
25 @echo " json to make JSON files"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
26 @echo " htmlhelp to make HTML files and a HTML help project"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
27 @echo " qthelp to make HTML files and a qthelp project"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
28 @echo " devhelp to make HTML files and a Devhelp project"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
29 @echo " epub to make an epub"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
30 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
31 @echo " latexpdf to make LaTeX files and run them through pdflatex"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
32 @echo " text to make text files"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
33 @echo " man to make manual pages"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
34 @echo " texinfo to make Texinfo files"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
35 @echo " info to make Texinfo files and run them through makeinfo"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
36 @echo " gettext to make PO message catalogs"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
37 @echo " changes to make an overview of all changed/added/deprecated items"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
38 @echo " linkcheck to check all external links for integrity"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
39 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
40
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
41 clean:
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
42 -rm -rf $(BUILDDIR)/*
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
43
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
44 html:
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
45 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
46 @echo
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
47 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
48
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
49 dirhtml:
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
50 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
51 @echo
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
52 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
53
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
54 singlehtml:
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
55 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
56 @echo
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
57 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
58
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
59 pickle:
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
60 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
61 @echo
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
62 @echo "Build finished; now you can process the pickle files."
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
63
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
64 json:
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
65 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
66 @echo
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
67 @echo "Build finished; now you can process the JSON files."
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
68
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
69 htmlhelp:
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
70 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
71 @echo
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
72 @echo "Build finished; now you can run HTML Help Workshop with the" \
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
73 ".hhp project file in $(BUILDDIR)/htmlhelp."
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
74
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
75 qthelp:
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
76 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
77 @echo
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
78 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
79 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
80 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/lcfos.qhcp"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
81 @echo "To view the help file:"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
82 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/lcfos.qhc"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
83
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
84 devhelp:
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
85 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
86 @echo
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
87 @echo "Build finished."
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
88 @echo "To view the help file:"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
89 @echo "# mkdir -p $$HOME/.local/share/devhelp/lcfos"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
90 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/lcfos"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
91 @echo "# devhelp"
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
92
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
93 epub:
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
94 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
95 @echo
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
96 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
97
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
98 latex:
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
99 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
100 @echo
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
101 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
102 @echo "Run \`make' in that directory to run these through (pdf)latex" \
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
103 "(use \`make latexpdf' here to do that automatically)."
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
104
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
105 latexpdf:
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
106 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
107 @echo "Running LaTeX files through pdflatex..."
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
108 $(MAKE) -C $(BUILDDIR)/latex all-pdf
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
109 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
110
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
111 text:
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
112 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
113 @echo
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
114 @echo "Build finished. The text files are in $(BUILDDIR)/text."
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
115
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
116 man:
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
117 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
118 @echo
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
119 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
120
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
121 texinfo:
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
122 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
123 @echo
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
124 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
125 @echo "Run \`make' in that directory to run these through makeinfo" \
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
126 "(use \`make info' here to do that automatically)."
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
127
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
128 info:
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
129 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
130 @echo "Running Texinfo files through makeinfo..."
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
131 make -C $(BUILDDIR)/texinfo info
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
132 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
133
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
134 gettext:
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
135 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
136 @echo
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
137 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
138
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
139 changes:
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
140 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
141 @echo
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
142 @echo "The overview file is in $(BUILDDIR)/changes."
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
143
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
144 linkcheck:
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
145 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
146 @echo
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
147 @echo "Link check complete; look for any errors in the above output " \
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
148 "or in $(BUILDDIR)/linkcheck/output.txt."
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
149
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
150 doctest:
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
151 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
152 @echo "Testing of doctests in the sources finished, look at the " \
6b3a874edd6e Added some docs
Windel Bouwman
parents:
diff changeset
153 "results in $(BUILDDIR)/doctest/output.txt."