Debian Codegraph @

docs/Makefile

raw
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 # 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/)
13 endif
14
15 # Internal variables.
16 PAPEROPT_a4 = -D latex_paper_size=a4
17 PAPEROPT_letter = -D latex_paper_size=letter
18 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
19 # the i18n builder cannot share the environment and doctrees with the others
20 I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
21
22 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
23
24 help:
25 @echo "Please use \`make <target>' where <target> is one of"
26 @echo " html to make standalone HTML files"
27 @echo " dirhtml to make HTML files named index.html in directories"
28 @echo " singlehtml to make a single large HTML file"
29 @echo " pickle to make pickle files"
30 @echo " json to make JSON files"
31 @echo " htmlhelp to make HTML files and a HTML help project"
32 @echo " qthelp to make HTML files and a qthelp project"
33 @echo " applehelp to make an Apple Help Book"
34 @echo " devhelp to make HTML files and a Devhelp project"
35 @echo " epub to make an epub"
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
51 clean:
52 rm -rf $(BUILDDIR)/*
53 rm source/config_options.rst
54
55 html:
56 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
57 @echo
58 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
59
60 dirhtml:
61 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
62 @echo
63 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
64
65 singlehtml:
66 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
67 @echo
68 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
69
70 pickle:
71 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
72 @echo
73 @echo "Build finished; now you can process the pickle files."
74
75 json:
76 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
77 @echo
78 @echo "Build finished; now you can process the JSON files."
79
80 htmlhelp:
81 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
82 @echo
83 @echo "Build finished; now you can run HTML Help Workshop with the" \
84 ".hhp project file in $(BUILDDIR)/htmlhelp."
85
86 qthelp:
87 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
88 @echo
89 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
90 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
91 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/nbconvert.qhcp"
92 @echo "To view the help file:"
93 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/nbconvert.qhc"
94
95 applehelp:
96 $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
97 @echo
98 @echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
99 @echo "N.B. You won't be able to view it unless you put it in" \
100 "~/Library/Documentation/Help or install it in your application" \
101 "bundle."
102
103 devhelp:
104 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
105 @echo
106 @echo "Build finished."
107 @echo "To view the help file:"
108 @echo "# mkdir -p $$HOME/.local/share/devhelp/nbconvert"
109 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/nbconvert"
110 @echo "# devhelp"
111
112 epub:
113 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
114 @echo
115 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
116
117 latex:
118 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
119 @echo
120 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
121 @echo "Run \`make' in that directory to run these through (pdf)latex" \
122 "(use \`make latexpdf' here to do that automatically)."
123
124 latexpdf:
125 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
126 @echo "Running LaTeX files through pdflatex..."
127 $(MAKE) -C $(BUILDDIR)/latex all-pdf
128 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
129
130 latexpdfja:
131 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
132 @echo "Running LaTeX files through platex and dvipdfmx..."
133 $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
134 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
135
136 text:
137 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
138 @echo
139 @echo "Build finished. The text files are in $(BUILDDIR)/text."
140
141 man:
142 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
143 @echo
144 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
145
146 texinfo:
147 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
148 @echo
149 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
150 @echo "Run \`make' in that directory to run these through makeinfo" \
151 "(use \`make info' here to do that automatically)."
152
153 info:
154 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
155 @echo "Running Texinfo files through makeinfo..."
156 make -C $(BUILDDIR)/texinfo info
157 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
158
159 gettext:
160 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
161 @echo
162 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
163
164 changes:
165 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
166 @echo
167 @echo "The overview file is in $(BUILDDIR)/changes."
168
169 linkcheck:
170 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
171 @echo
172 @echo "Link check complete; look for any errors in the above output " \
173 "or in $(BUILDDIR)/linkcheck/output.txt."
174
175 doctest:
176 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
177 @echo "Testing of doctests in the sources finished, look at the " \
178 "results in $(BUILDDIR)/doctest/output.txt."
179
180 coverage:
181 $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
182 @echo "Testing of coverage in the sources finished, look at the " \
183 "results in $(BUILDDIR)/coverage/python.txt."
184
185 xml:
186 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
187 @echo
188 @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
189
190 pseudoxml:
191 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
192 @echo
193 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."