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 SPHINXBUILD
= sphinx-1.0
-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/)
19 PAPEROPT_a4 = -D latex_paper_size=a4
20 PAPEROPT_letter = -D latex_paper_size=letter
21 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
22 # the i18n builder cannot share the environment and doctrees with the others
23 I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
27 @echo "Please use \`make <target>' where
<target
> is one of
"
28 @echo " html to make standalone HTML files
"
29 @echo " dirhtml to make HTML files named index.html in directories
"
30 @echo " singlehtml to make a single large HTML file
"
31 @echo " pickle to make pickle files
"
32 @echo " json to make JSON files
"
33 @echo " htmlhelp to make HTML files and a HTML help project
"
34 @echo " qthelp to make HTML files and a qthelp project
"
35 @echo " applehelp to make an Apple Help Book
"
36 @echo " devhelp to make HTML files and a Devhelp project
"
37 @echo " epub to make an epub
"
38 @echo " latex to make LaTeX files
, you can set PAPER
=a4 or PAPER
=letter
"
39 @echo " latexpdf to make LaTeX files and run them through pdflatex
"
40 @echo " latexpdfja to make LaTeX files and run them through platex
/dvipdfmx
"
41 @echo " text to make text files
"
42 @echo " man to make manual pages
"
43 @echo " texinfo to make Texinfo files
"
44 @echo " info to make Texinfo files and run them through
makeinfo"
45 @echo " gettext to make PO message catalogs
"
46 @echo " changes to make an overview of
all changed
/added
/deprecated items
"
47 @echo " xml to make Docutils-native XML files
"
48 @echo " pseudoxml to make pseudoxml-XML files for display purposes
"
49 @echo " linkcheck to
check all external links for integrity
"
50 @echo " doctest to run
all doctests embedded in the documentation
(if enabled
)"
51 @echo " coverage to run coverage
check of the documentation
(if enabled
)"
59 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
61 @echo "Build finished. The HTML pages are in
$(BUILDDIR
)/html.
"
65 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
67 @echo "Build finished. The HTML pages are in
$(BUILDDIR
)/dirhtml.
"
71 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
73 @echo "Build finished. The HTML page is in
$(BUILDDIR
)/singlehtml.
"
77 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
79 @echo "Build finished
; now you can process the pickle files.
"
83 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
85 @echo "Build finished
; now you can process the JSON files.
"
89 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
91 @echo "Build finished
; now you can run HTML Help Workshop with the
" \
92 ".hhp project file in
$(BUILDDIR
)/htmlhelp.
"
96 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
98 @echo "Build finished
; now you can run
"qcollectiongenerator" with the
" \
99 ".qhcp project file in
$(BUILDDIR
)/qthelp
, like this
:"
100 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/FRR.qhcp"
101 @echo
"To view the help file:"
102 @echo
"# assistant -collectionFile $(BUILDDIR)/qthelp/FRR.qhc"
106 $(SPHINXBUILD
) -b applehelp
$(ALLSPHINXOPTS
) $(BUILDDIR
)/applehelp
108 @echo
"Build finished. The help book is in $(BUILDDIR)/applehelp."
109 @echo
"N.B. You won't be able to view it unless you put it in" \
110 "~/Library/Documentation/Help or install it in your application" \
115 $(SPHINXBUILD
) -b devhelp
$(ALLSPHINXOPTS
) $(BUILDDIR
)/devhelp
117 @echo
"Build finished."
118 @echo
"To view the help file:"
119 @echo
"# mkdir -p $$HOME/.local/share/devhelp/FRR"
120 @echo
"# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FRR"
125 $(SPHINXBUILD
) -b epub
$(ALLSPHINXOPTS
) $(BUILDDIR
)/epub
127 @echo
"Build finished. The epub file is in $(BUILDDIR)/epub."
131 $(SPHINXBUILD
) -b latex
$(ALLSPHINXOPTS
) $(BUILDDIR
)/latex
133 @echo
"Build finished; the LaTeX files are in $(BUILDDIR)/latex."
134 @echo
"Run \`make' in that directory to run these through (pdf)latex" \
135 "(use \`make latexpdf' here to do that automatically)."
139 $(SPHINXBUILD
) -b latex
$(ALLSPHINXOPTS
) $(BUILDDIR
)/latex
140 @echo
"Running LaTeX files through pdflatex..."
141 $(MAKE
) -C
$(BUILDDIR
)/latex all-pdf
142 @echo
"pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
146 $(SPHINXBUILD
) -b latex
$(ALLSPHINXOPTS
) $(BUILDDIR
)/latex
147 @echo
"Running LaTeX files through platex and dvipdfmx..."
148 $(MAKE
) -C
$(BUILDDIR
)/latex all-pdf-ja
149 @echo
"pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
153 $(SPHINXBUILD
) -b text
$(ALLSPHINXOPTS
) $(BUILDDIR
)/text
155 @echo
"Build finished. The text files are in $(BUILDDIR)/text."
159 $(SPHINXBUILD
) -b man
$(ALLSPHINXOPTS
) $(BUILDDIR
)/man
161 @echo
"Build finished. The manual pages are in $(BUILDDIR)/man."
165 $(SPHINXBUILD
) -b texinfo
$(ALLSPHINXOPTS
) $(BUILDDIR
)/texinfo
167 @echo
"Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
168 @echo
"Run \`make' in that directory to run these through makeinfo" \
169 "(use \`make info' here to do that automatically)."
173 $(SPHINXBUILD
) -b texinfo
$(ALLSPHINXOPTS
) $(BUILDDIR
)/texinfo
174 @echo
"Running Texinfo files through makeinfo..."
175 $(MAKE
) -C
$(BUILDDIR
)/texinfo
info
176 @echo
"makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
180 $(SPHINXBUILD
) -b gettext
$(I18NSPHINXOPTS
) $(BUILDDIR
)/locale
182 @echo
"Build finished. The message catalogs are in $(BUILDDIR)/locale."
186 $(SPHINXBUILD
) -b changes
$(ALLSPHINXOPTS
) $(BUILDDIR
)/changes
188 @echo
"The overview file is in $(BUILDDIR)/changes."
192 $(SPHINXBUILD
) -b linkcheck
$(ALLSPHINXOPTS
) $(BUILDDIR
)/linkcheck
194 @echo
"Link check complete; look for any errors in the above output " \
195 "or in $(BUILDDIR)/linkcheck/output.txt."
199 $(SPHINXBUILD
) -b doctest
$(ALLSPHINXOPTS
) $(BUILDDIR
)/doctest
200 @echo
"Testing of doctests in the sources finished, look at the " \
201 "results in $(BUILDDIR)/doctest/output.txt."
205 $(SPHINXBUILD
) -b coverage
$(ALLSPHINXOPTS
) $(BUILDDIR
)/coverage
206 @echo
"Testing of coverage in the sources finished, look at the " \
207 "results in $(BUILDDIR)/coverage/python.txt."
211 $(SPHINXBUILD
) -b xml
$(ALLSPHINXOPTS
) $(BUILDDIR
)/xml
213 @echo
"Build finished. The XML files are in $(BUILDDIR)/xml."
217 $(SPHINXBUILD
) -b pseudoxml
$(ALLSPHINXOPTS
) $(BUILDDIR
)/pseudoxml
219 @echo
"Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."