Debian Codegraph @

mysqlx-connector-python/docs/mysqlx/Makefile

raw
1 # Copyright (c) 2017, 2026, Oracle and/or its affiliates.
2 #
3 # This program is free software; you can redistribute it and/or modify
4 # it under the terms of the GNU General Public License, version 2.0, as
5 # published by the Free Software Foundation.
6 #
7 # This program is designed to work with certain software (including
8 # but not limited to OpenSSL) that is licensed under separate terms,
9 # as designated in a particular file or component or in included license
10 # documentation. The authors of MySQL hereby grant you an
11 # additional permission to link the program and your derivative works
12 # with the separately licensed software that they have either included with
13 # the program or referenced in the documentation.
14 #
15 # Without limiting anything contained in the foregoing, this file,
16 # which is part of MySQL Connector/Python, is also subject to the
17 # Universal FOSS Exception, version 1.0, a copy of which can be found at
18 # http://oss.oracle.com/licenses/universal-foss-exception.
19 #
20 # This program is distributed in the hope that it will be useful, but
21 # WITHOUT ANY WARRANTY; without even the implied warranty of
22 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
23 # See the GNU General Public License, version 2.0, for more details.
24 #
25 # You should have received a copy of the GNU General Public License
26 # along with this program; if not, write to the Free Software Foundation, Inc.,
27 # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
28
29 # Makefile for Sphinx documentation
30 #
31
32 # You can set these variables from the command line.
33 SPHINXOPTS =
34 SPHINXBUILD = sphinx-build
35 PAPER =
36 BUILDDIR = _build
37
38 # Internal variables.
39 PAPEROPT_a4 = -D latex_paper_size=a4
40 PAPEROPT_letter = -D latex_paper_size=letter
41 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
42 # the i18n builder cannot share the environment and doctrees with the others
43 I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
44
45 .PHONY: help
46 help:
47 @echo "Please use \`make <target>' where <target> is one of"
48 @echo " html to make standalone HTML files"
49 @echo " dirhtml to make HTML files named index.html in directories"
50 @echo " singlehtml to make a single large HTML file"
51 @echo " pickle to make pickle files"
52 @echo " json to make JSON files"
53 @echo " htmlhelp to make HTML files and a HTML help project"
54 @echo " qthelp to make HTML files and a qthelp project"
55 @echo " applehelp to make an Apple Help Book"
56 @echo " devhelp to make HTML files and a Devhelp project"
57 @echo " epub to make an epub"
58 @echo " epub3 to make an epub3"
59 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
60 @echo " latexpdf to make LaTeX files and run them through pdflatex"
61 @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
62 @echo " text to make text files"
63 @echo " man to make manual pages"
64 @echo " texinfo to make Texinfo files"
65 @echo " info to make Texinfo files and run them through makeinfo"
66 @echo " gettext to make PO message catalogs"
67 @echo " changes to make an overview of all changed/added/deprecated items"
68 @echo " xml to make Docutils-native XML files"
69 @echo " pseudoxml to make pseudoxml-XML files for display purposes"
70 @echo " linkcheck to check all external links for integrity"
71 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
72 @echo " coverage to run coverage check of the documentation (if enabled)"
73 @echo " dummy to check syntax errors of document sources"
74
75 .PHONY: clean
76 clean:
77 rm -rf $(BUILDDIR)/*
78
79 .PHONY: html
80 html:
81 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
82 @echo
83 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
84
85 .PHONY: dirhtml
86 dirhtml:
87 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
88 @echo
89 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
90
91 .PHONY: singlehtml
92 singlehtml:
93 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
94 @echo
95 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
96
97 .PHONY: pickle
98 pickle:
99 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
100 @echo
101 @echo "Build finished; now you can process the pickle files."
102
103 .PHONY: json
104 json:
105 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
106 @echo
107 @echo "Build finished; now you can process the JSON files."
108
109 .PHONY: htmlhelp
110 htmlhelp:
111 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
112 @echo
113 @echo "Build finished; now you can run HTML Help Workshop with the" \
114 ".hhp project file in $(BUILDDIR)/htmlhelp."
115
116 .PHONY: qthelp
117 qthelp:
118 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
119 @echo
120 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
121 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
122 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/mysqlx.qhcp"
123 @echo "To view the help file:"
124 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/mysqlx.qhc"
125
126 .PHONY: applehelp
127 applehelp:
128 $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
129 @echo
130 @echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
131 @echo "N.B. You won't be able to view it unless you put it in" \
132 "~/Library/Documentation/Help or install it in your application" \
133 "bundle."
134
135 .PHONY: devhelp
136 devhelp:
137 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
138 @echo
139 @echo "Build finished."
140 @echo "To view the help file:"
141 @echo "# mkdir -p $$HOME/.local/share/devhelp/mysqlx"
142 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/mysqlx"
143 @echo "# devhelp"
144
145 .PHONY: epub
146 epub:
147 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
148 @echo
149 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
150
151 .PHONY: epub3
152 epub3:
153 $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
154 @echo
155 @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
156
157 .PHONY: latex
158 latex:
159 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
160 @echo
161 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
162 @echo "Run \`make' in that directory to run these through (pdf)latex" \
163 "(use \`make latexpdf' here to do that automatically)."
164
165 .PHONY: latexpdf
166 latexpdf:
167 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
168 @echo "Running LaTeX files through pdflatex..."
169 $(MAKE) -C $(BUILDDIR)/latex all-pdf
170 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
171
172 .PHONY: latexpdfja
173 latexpdfja:
174 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
175 @echo "Running LaTeX files through platex and dvipdfmx..."
176 $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
177 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
178
179 .PHONY: text
180 text:
181 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
182 @echo
183 @echo "Build finished. The text files are in $(BUILDDIR)/text."
184
185 .PHONY: man
186 man:
187 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
188 @echo
189 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
190
191 .PHONY: texinfo
192 texinfo:
193 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
194 @echo
195 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
196 @echo "Run \`make' in that directory to run these through makeinfo" \
197 "(use \`make info' here to do that automatically)."
198
199 .PHONY: info
200 info:
201 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
202 @echo "Running Texinfo files through makeinfo..."
203 make -C $(BUILDDIR)/texinfo info
204 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
205
206 .PHONY: gettext
207 gettext:
208 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
209 @echo
210 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
211
212 .PHONY: changes
213 changes:
214 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
215 @echo
216 @echo "The overview file is in $(BUILDDIR)/changes."
217
218 .PHONY: linkcheck
219 linkcheck:
220 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
221 @echo
222 @echo "Link check complete; look for any errors in the above output " \
223 "or in $(BUILDDIR)/linkcheck/output.txt."
224
225 .PHONY: doctest
226 doctest:
227 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
228 @echo "Testing of doctests in the sources finished, look at the " \
229 "results in $(BUILDDIR)/doctest/output.txt."
230
231 .PHONY: coverage
232 coverage:
233 $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
234 @echo "Testing of coverage in the sources finished, look at the " \
235 "results in $(BUILDDIR)/coverage/python.txt."
236
237 .PHONY: xml
238 xml:
239 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
240 @echo
241 @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
242
243 .PHONY: pseudoxml
244 pseudoxml:
245 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
246 @echo
247 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
248
249 .PHONY: dummy
250 dummy:
251 $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
252 @echo
253 @echo "Build finished. Dummy builder generates no files."