Skip to content

HTTPS clone URL

Subversion checkout URL

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