a8ae35e956e853ed9d4b23771ac292408e1e80a4
1 # Makefile for Sphinx documentation
2 #
4 default: html
6 # You can set these variables from the command line.
7 SPHINXOPTS =
8 SPHINXBUILD = sphinx-build
9 PAPER =
10 #BUILDDIR = /var/www/mctools/opencl
11 BUILDDIR = build
13 # User-friendly check for sphinx-build
14 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
15 $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
16 endif
18 # Internal variables.
19 PAPEROPT_a4 = -D latex_paper_size=a4
20 PAPEROPT_letter = -D latex_paper_size=letter
21 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
22 # the i18n builder cannot share the environment and doctrees with the others
23 I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
25 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
27 help:
28 @echo "Please use \`make <target>' where <target> is one of"
29 @echo " html to make standalone HTML files"
30 @echo " dirhtml to make HTML files named index.html in directories"
31 @echo " singlehtml to make a single large HTML file"
32 @echo " pickle to make pickle files"
33 @echo " json to make JSON files"
34 @echo " htmlhelp to make HTML files and a HTML help project"
35 @echo " qthelp to make HTML files and a qthelp project"
36 @echo " applehelp to make an Apple Help Book"
37 @echo " devhelp to make HTML files and a Devhelp project"
38 @echo " epub to make an epub"
39 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
40 @echo " latexpdf to make LaTeX files and run them through pdflatex"
41 @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
42 @echo " text to make text files"
43 @echo " man to make manual pages"
44 @echo " texinfo to make Texinfo files"
45 @echo " info to make Texinfo files and run them through makeinfo"
46 @echo " gettext to make PO message catalogs"
47 @echo " changes to make an overview of all changed/added/deprecated items"
48 @echo " xml to make Docutils-native XML files"
49 @echo " pseudoxml to make pseudoxml-XML files for display purposes"
50 @echo " linkcheck to check all external links for integrity"
51 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
52 @echo " coverage to run coverage check of the documentation (if enabled)"
54 clean:
55 rm -rf $(BUILDDIR)/*
57 html:
58 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)
59 @echo
60 @echo "Build finished. The HTML pages are in $(BUILDDIR)."
62 dirhtml:
63 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
64 @echo
65 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
67 singlehtml:
68 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
69 @echo
70 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
72 pickle:
73 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
74 @echo
75 @echo "Build finished; now you can process the pickle files."
77 json:
78 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
79 @echo
80 @echo "Build finished; now you can process the JSON files."
82 htmlhelp:
83 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
84 @echo
85 @echo "Build finished; now you can run HTML Help Workshop with the" \
86 ".hhp project file in $(BUILDDIR)/htmlhelp."
88 qthelp:
89 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
90 @echo
91 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
92 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
93 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/TIOpenCL.qhcp"
94 @echo "To view the help file:"
95 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/TIOpenCL.qhc"
97 applehelp:
98 $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
99 @echo
100 @echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
101 @echo "N.B. You won't be able to view it unless you put it in" \
102 "~/Library/Documentation/Help or install it in your application" \
103 "bundle."
105 devhelp:
106 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
107 @echo
108 @echo "Build finished."
109 @echo "To view the help file:"
110 @echo "# mkdir -p $$HOME/.local/share/devhelp/TIOpenCL"
111 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/TIOpenCL"
112 @echo "# devhelp"
114 epub:
115 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
116 @echo
117 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
119 latex:
120 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
121 @echo
122 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
123 @echo "Run \`make' in that directory to run these through (pdf)latex" \
124 "(use \`make latexpdf' here to do that automatically)."
126 latexpdf:
127 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
128 @echo "Running LaTeX files through pdflatex..."
129 $(MAKE) -C $(BUILDDIR)/latex all-pdf
130 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
132 latexpdfja:
133 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
134 @echo "Running LaTeX files through platex and dvipdfmx..."
135 $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
136 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
138 text:
139 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
140 @echo
141 @echo "Build finished. The text files are in $(BUILDDIR)/text."
143 man:
144 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
145 @echo
146 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
148 texinfo:
149 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
150 @echo
151 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
152 @echo "Run \`make' in that directory to run these through makeinfo" \
153 "(use \`make info' here to do that automatically)."
155 info:
156 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
157 @echo "Running Texinfo files through makeinfo..."
158 make -C $(BUILDDIR)/texinfo info
159 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
161 gettext:
162 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
163 @echo
164 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
166 changes:
167 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
168 @echo
169 @echo "The overview file is in $(BUILDDIR)/changes."
171 linkcheck:
172 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
173 @echo
174 @echo "Link check complete; look for any errors in the above output " \
175 "or in $(BUILDDIR)/linkcheck/output.txt."
177 doctest:
178 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
179 @echo "Testing of doctests in the sources finished, look at the " \
180 "results in $(BUILDDIR)/doctest/output.txt."
182 coverage:
183 $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
184 @echo "Testing of coverage in the sources finished, look at the " \
185 "results in $(BUILDDIR)/coverage/python.txt."
187 xml:
188 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
189 @echo
190 @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
192 pseudoxml:
193 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
194 @echo
195 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
197 artifacts:
198 $(MAKE) -c artifacts