1 # Makefile for Sphinx documentation
4 # You can set these variables from the command line.
6 SPHINXBUILD
= sphinx-build
10 # User-friendly check for sphinx-build
11 ifeq ($(shell which
$(SPHINXBUILD
) >/dev
/null
2>&1; echo
$$?
), 1)
12 $(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 PAPEROPT_a4
= -D latex_paper_size
=a4
17 PAPEROPT_letter
= -D latex_paper_size
=letter
18 ALLSPHINXOPTS
= -d
$(BUILDDIR
)/doctrees
$(PAPEROPT_
$(PAPER
)) $(SPHINXOPTS
) .
19 # the i18n builder cannot share the environment and doctrees with the others
20 I18NSPHINXOPTS
= $(PAPEROPT_
$(PAPER
)) $(SPHINXOPTS
) .
24 @echo
"Please use \`make <target>' where <target> is one of"
25 @echo
" html to make standalone HTML files"
26 @echo
" dirhtml to make HTML files named index.html in directories"
27 @echo
" singlehtml to make a single large HTML file"
28 @echo
" pickle to make pickle files"
29 @echo
" json to make JSON files"
30 @echo
" htmlhelp to make HTML files and a HTML help project"
31 @echo
" qthelp to make HTML files and a qthelp project"
32 @echo
" applehelp to make an Apple Help Book"
33 @echo
" devhelp to make HTML files and a Devhelp project"
34 @echo
" epub to make an epub"
35 @echo
" epub3 to make an epub3"
36 @echo
" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
37 @echo
" latexpdf to make LaTeX files and run them through pdflatex"
38 @echo
" latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
39 @echo
" text to make text files"
40 @echo
" man to make manual pages"
41 @echo
" texinfo to make Texinfo files"
42 @echo
" info to make Texinfo files and run them through makeinfo"
43 @echo
" gettext to make PO message catalogs"
44 @echo
" changes to make an overview of all changed/added/deprecated items"
45 @echo
" xml to make Docutils-native XML files"
46 @echo
" pseudoxml to make pseudoxml-XML files for display purposes"
47 @echo
" linkcheck to check all external links for integrity"
48 @echo
" doctest to run all doctests embedded in the documentation (if enabled)"
49 @echo
" coverage to run coverage check of the documentation (if enabled)"
50 @echo
" dummy to check syntax errors of document sources"
58 $(SPHINXBUILD
) -b html
$(ALLSPHINXOPTS
) $(BUILDDIR
)/html
60 @echo
"Build finished. The HTML pages are in $(BUILDDIR)/html."
64 $(SPHINXBUILD
) -b dirhtml
$(ALLSPHINXOPTS
) $(BUILDDIR
)/dirhtml
66 @echo
"Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
70 $(SPHINXBUILD
) -b singlehtml
$(ALLSPHINXOPTS
) $(BUILDDIR
)/singlehtml
72 @echo
"Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
76 $(SPHINXBUILD
) -b pickle
$(ALLSPHINXOPTS
) $(BUILDDIR
)/pickle
78 @echo
"Build finished; now you can process the pickle files."
82 $(SPHINXBUILD
) -b json
$(ALLSPHINXOPTS
) $(BUILDDIR
)/json
84 @echo
"Build finished; now you can process the JSON files."
88 $(SPHINXBUILD
) -b htmlhelp
$(ALLSPHINXOPTS
) $(BUILDDIR
)/htmlhelp
90 @echo
"Build finished; now you can run HTML Help Workshop with the" \
91 ".hhp project file in $(BUILDDIR)/htmlhelp."
95 $(SPHINXBUILD
) -b qthelp
$(ALLSPHINXOPTS
) $(BUILDDIR
)/qthelp
97 @echo
"Build finished; now you can run "qcollectiongenerator
" with the" \
98 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
99 @echo
"# qcollectiongenerator $(BUILDDIR)/qthelp/libjuju.qhcp"
100 @echo
"To view the help file:"
101 @echo
"# assistant -collectionFile $(BUILDDIR)/qthelp/libjuju.qhc"
105 $(SPHINXBUILD
) -b applehelp
$(ALLSPHINXOPTS
) $(BUILDDIR
)/applehelp
107 @echo
"Build finished. The help book is in $(BUILDDIR)/applehelp."
108 @echo
"N.B. You won't be able to view it unless you put it in" \
109 "~/Library/Documentation/Help or install it in your application" \
114 $(SPHINXBUILD
) -b devhelp
$(ALLSPHINXOPTS
) $(BUILDDIR
)/devhelp
116 @echo
"Build finished."
117 @echo
"To view the help file:"
118 @echo
"# mkdir -p $$HOME/.local/share/devhelp/libjuju"
119 @echo
"# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/libjuju"
124 $(SPHINXBUILD
) -b epub
$(ALLSPHINXOPTS
) $(BUILDDIR
)/epub
126 @echo
"Build finished. The epub file is in $(BUILDDIR)/epub."
130 $(SPHINXBUILD
) -b epub3
$(ALLSPHINXOPTS
) $(BUILDDIR
)/epub3
132 @echo
"Build finished. The epub3 file is in $(BUILDDIR)/epub3."
136 $(SPHINXBUILD
) -b latex
$(ALLSPHINXOPTS
) $(BUILDDIR
)/latex
138 @echo
"Build finished; the LaTeX files are in $(BUILDDIR)/latex."
139 @echo
"Run \`make' in that directory to run these through (pdf)latex" \
140 "(use \`make latexpdf' here to do that automatically)."
144 $(SPHINXBUILD
) -b latex
$(ALLSPHINXOPTS
) $(BUILDDIR
)/latex
145 @echo
"Running LaTeX files through pdflatex..."
146 $(MAKE
) -C
$(BUILDDIR
)/latex all-pdf
147 @echo
"pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
151 $(SPHINXBUILD
) -b latex
$(ALLSPHINXOPTS
) $(BUILDDIR
)/latex
152 @echo
"Running LaTeX files through platex and dvipdfmx..."
153 $(MAKE
) -C
$(BUILDDIR
)/latex all-pdf-ja
154 @echo
"pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
158 $(SPHINXBUILD
) -b text
$(ALLSPHINXOPTS
) $(BUILDDIR
)/text
160 @echo
"Build finished. The text files are in $(BUILDDIR)/text."
164 $(SPHINXBUILD
) -b man
$(ALLSPHINXOPTS
) $(BUILDDIR
)/man
166 @echo
"Build finished. The manual pages are in $(BUILDDIR)/man."
170 $(SPHINXBUILD
) -b texinfo
$(ALLSPHINXOPTS
) $(BUILDDIR
)/texinfo
172 @echo
"Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
173 @echo
"Run \`make' in that directory to run these through makeinfo" \
174 "(use \`make info' here to do that automatically)."
178 $(SPHINXBUILD
) -b texinfo
$(ALLSPHINXOPTS
) $(BUILDDIR
)/texinfo
179 @echo
"Running Texinfo files through makeinfo..."
180 make
-C
$(BUILDDIR
)/texinfo
info
181 @echo
"makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
185 $(SPHINXBUILD
) -b gettext
$(I18NSPHINXOPTS
) $(BUILDDIR
)/locale
187 @echo
"Build finished. The message catalogs are in $(BUILDDIR)/locale."
191 $(SPHINXBUILD
) -b changes
$(ALLSPHINXOPTS
) $(BUILDDIR
)/changes
193 @echo
"The overview file is in $(BUILDDIR)/changes."
197 $(SPHINXBUILD
) -b linkcheck
$(ALLSPHINXOPTS
) $(BUILDDIR
)/linkcheck
199 @echo
"Link check complete; look for any errors in the above output " \
200 "or in $(BUILDDIR)/linkcheck/output.txt."
204 $(SPHINXBUILD
) -b doctest
$(ALLSPHINXOPTS
) $(BUILDDIR
)/doctest
205 @echo
"Testing of doctests in the sources finished, look at the " \
206 "results in $(BUILDDIR)/doctest/output.txt."
210 $(SPHINXBUILD
) -b coverage
$(ALLSPHINXOPTS
) $(BUILDDIR
)/coverage
211 @echo
"Testing of coverage in the sources finished, look at the " \
212 "results in $(BUILDDIR)/coverage/python.txt."
216 $(SPHINXBUILD
) -b xml
$(ALLSPHINXOPTS
) $(BUILDDIR
)/xml
218 @echo
"Build finished. The XML files are in $(BUILDDIR)/xml."
222 $(SPHINXBUILD
) -b pseudoxml
$(ALLSPHINXOPTS
) $(BUILDDIR
)/pseudoxml
224 @echo
"Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
228 $(SPHINXBUILD
) -b dummy
$(ALLSPHINXOPTS
) $(BUILDDIR
)/dummy
230 @echo
"Build finished. Dummy builder generates no files."