Cleanup this include file for docs.
[awesomized/libmemcached] / docs / include.am
1 # vim:ft=automake
2 # included from Top Level Makefile.am
3 # All paths should be given relative to the root
4
5 EXTRA_DIST+= \
6 docs/hashkit_clone.rst \
7 docs/hashkit_crc32.rst \
8 docs/hashkit_create.rst \
9 docs/hashkit_fnv1_32.rst \
10 docs/hashkit_fnv1_64.rst \
11 docs/hashkit_fnv1a_32.rst \
12 docs/hashkit_fnv1a_64.rst \
13 docs/hashkit_free.rst \
14 docs/hashkit_functions.rst \
15 docs/hashkit_hsieh.rst \
16 docs/hashkit_is_allocated.rst \
17 docs/hashkit_jenkins.rst \
18 docs/hashkit_md5.rst \
19 docs/hashkit_murmur.rst \
20 docs/hashkit_value.rst \
21 docs/index.rst \
22 docs/libmemcached_examples.rst \
23 docs/libmemcached.rst \
24 docs/libmemcachedutil.rst \
25 docs/memcached_add_by_key.rst \
26 docs/memcached_add.rst \
27 docs/memcached_analyze.rst \
28 docs/memcached_append_by_key.rst \
29 docs/memcached_append.rst \
30 docs/memcached_auto.rst \
31 docs/memcached_behavior_get.rst \
32 docs/memcached_behavior.rst \
33 docs/memcached_behavior_set.rst \
34 docs/memcached_callback_get.rst \
35 docs/memcached_callback.rst \
36 docs/memcached_callback_set.rst \
37 docs/memcached_cas_by_key.rst \
38 docs/memcached_cas.rst \
39 docs/memcached_clone.rst \
40 docs/memcached_create.rst \
41 docs/memcached_decrement.rst \
42 docs/memcached_decrement_with_initial.rst \
43 docs/memcached_delete_by_key.rst \
44 docs/memcached_delete.rst \
45 docs/memcached_destroy_sasl_auth_data.rst \
46 docs/memcached_dump.rst \
47 docs/memcached_fetch_execute.rst \
48 docs/memcached_fetch_result.rst \
49 docs/memcached_fetch.rst \
50 docs/memcached_flush_buffers.rst \
51 docs/memcached_flush.rst \
52 docs/memcached_free.rst \
53 docs/memcached_generate_hash_value.rst \
54 docs/memcached_get_by_key.rst \
55 docs/memcached_get_memory_allocators.rst \
56 docs/memcached_get.rst \
57 docs/memcached_get_sasl_callbacks.rst \
58 docs/memcached_get_user_data.rst \
59 docs/memcached_increment.rst \
60 docs/memcached_increment_with_initial.rst \
61 docs/memcached_lib_version.rst \
62 docs/memcached_memory_allocators.rst \
63 docs/memcached_mget_by_key.rst \
64 docs/memcached_mget_execute_by_key.rst \
65 docs/memcached_mget_execute.rst \
66 docs/memcached_mget.rst \
67 docs/memcached_pool_behavior_get.rst \
68 docs/memcached_pool_behavior_set.rst \
69 docs/memcached_pool_create.rst \
70 docs/memcached_pool_destroy.rst \
71 docs/memcached_pool_push.rst \
72 docs/memcached_pool.rst \
73 docs/memcached_pool_rst.rst \
74 docs/memcached_prepend_by_key.rst \
75 docs/memcached_prepend.rst \
76 docs/memcached_quit.rst \
77 docs/memcached_replace_by_key.rst \
78 docs/memcached_replace.rst \
79 docs/memcached_result_cas.rst \
80 docs/memcached_result_create.rst \
81 docs/memcached_result_flags.rst \
82 docs/memcached_result_free.rst \
83 docs/memcached_result_key_length.rst \
84 docs/memcached_result_key_value.rst \
85 docs/memcached_result_length.rst \
86 docs/memcached_result_st.rst \
87 docs/memcached_result_value.rst \
88 docs/memcached_sasl.rst \
89 docs/memcached_sasl_set_auth_data.rst \
90 docs/memcached_server_add.rst \
91 docs/memcached_server_add_unix_socket.rst \
92 docs/memcached_server_count.rst \
93 docs/memcached_server_cursor.rst \
94 docs/memcached_server_list_append.rst \
95 docs/memcached_server_list_count.rst \
96 docs/memcached_server_list_free.rst \
97 docs/memcached_server_list.rst \
98 docs/memcached_server_push.rst \
99 docs/memcached_servers_parse.rst \
100 docs/memcached_servers_reset.rst \
101 docs/memcached_servers.rst \
102 docs/memcached_server_st.rst \
103 docs/memcached_set_by_key.rst \
104 docs/memcached_set_memory_allocators_context.rst \
105 docs/memcached_set_memory_allocators.rst \
106 docs/memcached_set.rst \
107 docs/memcached_set_sasl_callbacks.rst \
108 docs/memcached_set_user_data.rst \
109 docs/memcached_stat_execute.rst \
110 docs/memcached_stat_get_keys.rst \
111 docs/memcached_stat_get_value.rst \
112 docs/memcached_stat.rst \
113 docs/memcached_stat_servername.rst \
114 docs/memcached_stats.rst \
115 docs/memcached_strerror.rst \
116 docs/memcached_user_data.rst \
117 docs/memcached_verbosity.rst \
118 docs/memcached_version.rst \
119 docs/memcapable.rst \
120 docs/memcat.rst \
121 docs/memcp.rst \
122 docs/memdump.rst \
123 docs/memerror.rst \
124 docs/memflush.rst \
125 docs/memrm.rst \
126 docs/memslap.rst \
127 docs/memstat.rst \
128 docs/_static \
129 docs/_templates \
130 docs/conf.py \
131 docs/libmemcached.rst \
132 docs/libmemcached_examples.rst \
133 docs/libmemcachedutil.rst \
134 docs/memcached_analyze.rst \
135 docs/memcached_dump.rst \
136 docs/memcached_flush.rst \
137 docs/memcached_flush_buffers.rst \
138 docs/memcached_generate_hash_value.rst \
139 docs/memcached_quit.rst \
140 docs/memcached_strerror.rst \
141 docs/memcached_verbosity.rst \
142 docs/memcapable.rst \
143 docs/memcat.rst \
144 docs/memcp.rst \
145 docs/memdump.rst \
146 docs/memerror.rst \
147 docs/memflush.rst \
148 docs/memrm.rst \
149 docs/memslap.rst \
150 docs/memstat.rst
151
152 # Makefile for Sphinx documentation
153 #
154
155 SPHINXOPTS = ${SPHINX_WARNINGS} -D release=${PANDORA_RELEASE_VERSION}
156 PAPER =
157 SPHINX_BUILDDIR = ${top_builddir}/docs
158
159 # Internal variables.
160 PAPEROPT_a4 = -D latex_paper_size=a4
161 PAPEROPT_letter = -D latex_paper_size=letter
162 ALLSPHINXOPTS = -d $(SPHINX_BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) ${top_srcdir}/docs
163
164 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
165
166 if HAVE_RECENT_SPHINX
167
168 man_MANS+= \
169 docs/man/hashkit_crc32.3 \
170 docs/man/hashkit_create.3 \
171 docs/man/hashkit_fnv1_32.3 \
172 docs/man/hashkit_fnv1_64.3 \
173 docs/man/hashkit_fnv1a_32.3 \
174 docs/man/hashkit_fnv1a_64.3 \
175 docs/man/hashkit_free.3 \
176 docs/man/hashkit_functions.3 \
177 docs/man/hashkit_hsieh.3 \
178 docs/man/hashkit_is_allocated.3 \
179 docs/man/hashkit_jenkins.3 \
180 docs/man/hashkit_md5.3 \
181 docs/man/hashkit_murmur.3 \
182 docs/man/hashkit_value.3 \
183 docs/man/libmemcached.3 \
184 docs/man/libmemcached_examples.3 \
185 docs/man/libmemcachedutil.3 \
186 docs/man/memcached_add.3 \
187 docs/man/memcached_add_by_key.3 \
188 docs/man/memcached_analyze.3 \
189 docs/man/memcached_append.3 \
190 docs/man/memcached_append_by_key.3 \
191 docs/man/memcached_behavior_get.3 \
192 docs/man/memcached_behavior_set.3 \
193 docs/man/memcached_callback_get.3 \
194 docs/man/memcached_callback_set.3 \
195 docs/man/memcached_cas.3 \
196 docs/man/memcached_cas_by_key.3 \
197 docs/man/memcached_clone.3 \
198 docs/man/memcached_create.3 \
199 docs/man/memcached_decrement.3 \
200 docs/man/memcached_decrement_with_initial.3 \
201 docs/man/memcached_delete.3 \
202 docs/man/memcached_delete_by_key.3 \
203 docs/man/memcached_destroy_sasl_auth_data.3 \
204 docs/man/memcached_dump.3 \
205 docs/man/memcached_fetch.3 \
206 docs/man/memcached_fetch_execute.3 \
207 docs/man/memcached_fetch_result.3 \
208 docs/man/memcached_flush_buffers.3 \
209 docs/man/memcached_free.3 \
210 docs/man/memcached_generate_hash_value.3 \
211 docs/man/memcached_get.3 \
212 docs/man/memcached_get_by_key.3 \
213 docs/man/memcached_get_memory_allocators.3 \
214 docs/man/memcached_get_sasl_callbacks.3 \
215 docs/man/memcached_get_user_data.3 \
216 docs/man/memcached_increment.3 \
217 docs/man/memcached_increment_with_initial.3 \
218 docs/man/memcached_lib_version.3 \
219 docs/man/memcached_mget.3 \
220 docs/man/memcached_mget_by_key.3 \
221 docs/man/memcached_mget_execute.3 \
222 docs/man/memcached_mget_execute_by_key.3 \
223 docs/man/memcached_pool_behavior_get.3 \
224 docs/man/memcached_pool_behavior_set.3 \
225 docs/man/memcached_pool_create.3 \
226 docs/man/memcached_pool_destroy.3 \
227 docs/man/memcached_pool_pop.3 \
228 docs/man/memcached_pool_push.3 \
229 docs/man/memcached_prepend.3 \
230 docs/man/memcached_prepend_by_key.3 \
231 docs/man/memcached_quit.3 \
232 docs/man/memcached_replace.3 \
233 docs/man/memcached_replace_by_key.3 \
234 docs/man/memcached_sasl_set_auth_data.3 \
235 docs/man/memcached_server_add.3 \
236 docs/man/memcached_server_count.3 \
237 docs/man/memcached_server_cursor.3 \
238 docs/man/memcached_server_list.3 \
239 docs/man/memcached_server_list_append.3 \
240 docs/man/memcached_server_list_count.3 \
241 docs/man/memcached_server_list_free.3 \
242 docs/man/memcached_server_push.3 \
243 docs/man/memcached_servers_parse.3 \
244 docs/man/memcached_set.3 \
245 docs/man/memcached_set_by_key.3 \
246 docs/man/memcached_set_memory_allocators.3 \
247 docs/man/memcached_set_sasl_callbacks.3 \
248 docs/man/memcached_set_user_data.3 \
249 docs/man/memcached_stat.3 \
250 docs/man/memcached_stat_execute.3 \
251 docs/man/memcached_stat_get_keys.3 \
252 docs/man/memcached_stat_get_value.3 \
253 docs/man/memcached_stat_servername.3 \
254 docs/man/memcached_strerror.3 \
255 docs/man/memcached_verbosity.3 \
256 docs/man/memcached_version.3 \
257 docs/man/memcapable.1 \
258 docs/man/memcat.1 \
259 docs/man/memcp.1 \
260 docs/man/memdump.1 \
261 docs/man/memerror.1 \
262 docs/man/memflush.1 \
263 docs/man/memrm.1 \
264 docs/man/memslap.1 \
265 docs/man/memstat.1
266
267 DISTCLEANFILES+= \
268 docs/man/*
269
270 docs/man/hashkit_clone.3: man
271 docs/man/hashkit_crc32.3: man
272 docs/man/hashkit_create.3: man
273 docs/man/hashkit_fnv1_32.3: man
274 docs/man/hashkit_fnv1_64.3: man
275 docs/man/hashkit_fnv1a_32.3: man
276 docs/man/hashkit_fnv1a_64.3: man
277 docs/man/hashkit_free.3: man
278 docs/man/hashkit_functions.3: man
279 docs/man/hashkit_hsieh.3: man
280 docs/man/hashkit_is_allocated.3: man
281 docs/man/hashkit_jenkins.3: man
282 docs/man/hashkit_md5.3: man
283 docs/man/hashkit_murmur.3: man
284 docs/man/hashkit_value.3: man
285 docs/man/libmemcached.3: man
286 docs/man/libmemcached_examples.3: man
287 docs/man/libmemcachedutil.3: man
288 docs/man/memcached_add.3: man
289 docs/man/memcached_add_by_key.3: man
290 docs/man/memcached_analyze.3: man
291 docs/man/memcached_append.3: man
292 docs/man/memcached_append_by_key.3: man
293 docs/man/memcached_behavior_get.3: man
294 docs/man/memcached_behavior_set.3: man
295 docs/man/memcached_callback_get.3: man
296 docs/man/memcached_callback_set.3: man
297 docs/man/memcached_cas.3: man
298 docs/man/memcached_cas_by_key.3: man
299 docs/man/memcached_clone.3: man
300 docs/man/memcached_create.3: man
301 docs/man/memcached_decrement.3: man
302 docs/man/memcached_decrement_with_initial.3: man
303 docs/man/memcached_delete.3: man
304 docs/man/memcached_delete_by_key.3: man
305 docs/man/memcached_destroy_sasl_auth_data.3: man
306 docs/man/memcached_dump.3: man
307 docs/man/memcached_fetch.3: man
308 docs/man/memcached_fetch_execute.3: man
309 docs/man/memcached_fetch_result.3: man
310 docs/man/memcached_flush_buffers.3: man
311 docs/man/memcached_free.3: man
312 docs/man/memcached_generate_hash_value.3: man
313 docs/man/memcached_get.3: man
314 docs/man/memcached_get_by_key.3: man
315 docs/man/memcached_get_memory_allocators.3: man
316 docs/man/memcached_get_sasl_callbacks.3: man
317 docs/man/memcached_get_user_data.3: man
318 docs/man/memcached_increment.3: man
319 docs/man/memcached_increment_with_initial.3: man
320 docs/man/memcached_lib_version.3: man
321 docs/man/memcached_mget.3: man
322 docs/man/memcached_mget_by_key.3: man
323 docs/man/memcached_mget_execute.3: man
324 docs/man/memcached_mget_execute_by_key.3: man
325 docs/man/memcached_pool_behavior_get.3: man
326 docs/man/memcached_pool_behavior_set.3: man
327 docs/man/memcached_pool_create.3: man
328 docs/man/memcached_pool_destroy.3: man
329 docs/man/memcached_pool_pop.3: man
330 docs/man/memcached_pool_push.3: man
331 docs/man/memcached_prepend.3: man
332 docs/man/memcached_prepend_by_key.3: man
333 docs/man/memcached_quit.3: man
334 docs/man/memcached_replace.3: man
335 docs/man/memcached_replace_by_key.3: man
336 docs/man/memcached_sasl_set_auth_data.3: man
337 docs/man/memcached_server_add.3: man
338 docs/man/memcached_server_count.3: man
339 docs/man/memcached_server_cursor.3: man
340 docs/man/memcached_server_list.3: man
341 docs/man/memcached_server_list_append.3: man
342 docs/man/memcached_server_list_count.3: man
343 docs/man/memcached_server_list_free.3: man
344 docs/man/memcached_server_push.3: man
345 docs/man/memcached_servers_parse.3: man
346 docs/man/memcached_set.3: man
347 docs/man/memcached_set_by_key.3: man
348 docs/man/memcached_set_memory_allocators.3: man
349 docs/man/memcached_set_sasl_callbacks.3: man
350 docs/man/memcached_set_user_data.3: man
351 docs/man/memcached_stat.3: man
352 docs/man/memcached_stat_execute.3: man
353 docs/man/memcached_stat_get_keys.3: man
354 docs/man/memcached_stat_get_value.3: man
355 docs/man/memcached_stat_servername.3: man
356 docs/man/memcached_strerror.3: man
357 docs/man/memcached_verbosity.3: man
358 docs/man/memcached_version.3: man
359 docs/man/memcapable.1: man
360 docs/man/memcat.1: man
361 docs/man/memcp.1: man
362 docs/man/memdump.1: man
363 docs/man/memerror.1: man
364 docs/man/memflush.1: man
365 docs/man/memrm.1: man
366 docs/man/memslap.1: man
367 docs/man/memstat.1: man
368
369 endif
370
371 if HAVE_SPHINX
372 sphinx-help:
373 @echo "Please use \`make <target>' where <target> is one of"
374 @echo " html to make standalone HTML files"
375 @echo " dirhtml to make HTML files named index.html in directories"
376 @echo " singlehtml to make a single large HTML file"
377 @echo " pickle to make pickle files"
378 @echo " json to make JSON files"
379 @echo " htmlhelp to make HTML files and a HTML help project"
380 @echo " qthelp to make HTML files and a qthelp project"
381 @echo " devhelp to make HTML files and a Devhelp project"
382 @echo " epub to make an epub"
383 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
384 @echo " latexpdf to make LaTeX files and run them through pdflatex"
385 @echo " text to make text files"
386 @echo " man to make manual pages"
387 @echo " changes to make an overview of all changed/added/deprecated items"
388 @echo " linkcheck to check all external links for integrity"
389 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
390
391 html-local:
392 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/html
393 @echo
394 @echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/html."
395
396 dirhtml:
397 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/dirhtml
398 @echo
399 @echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/dirhtml."
400
401 singlehtml:
402 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/singlehtml
403 @echo
404 @echo "Build finished. The HTML page is in $(SPHINX_BUILDDIR)/singlehtml."
405
406 pickle:
407 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/pickle
408 @echo
409 @echo "Build finished; now you can process the pickle files."
410
411 json:
412 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/json
413 @echo
414 @echo "Build finished; now you can process the JSON files."
415
416 htmlhelp:
417 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/htmlhelp
418 @echo
419 @echo "Build finished; now you can run HTML Help Workshop with the" \
420 ".hhp project file in $(SPHINX_BUILDDIR)/htmlhelp."
421
422 qthelp:
423 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/qthelp
424 @echo
425 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
426 ".qhcp project file in $(SPHINX_BUILDDIR)/qthelp, like this:"
427 @echo "# qcollectiongenerator $(SPHINX_BUILDDIR)/qthelp/Libmemcached.qhcp"
428 @echo "To view the help file:"
429 @echo "# assistant -collectionFile $(SPHINX_BUILDDIR)/qthelp/Libmemcached.qhc"
430
431 devhelp:
432 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/devhelp
433 @echo
434 @echo "Build finished."
435 @echo "To view the help file:"
436 @echo "# mkdir -p $$HOME/.local/share/devhelp/Libmemcached"
437 @echo "# ln -s $(SPHINX_BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Libmemcached"
438 @echo "# devhelp"
439
440 epub:
441 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/epub
442 @echo
443 @echo "Build finished. The epub file is in $(SPHINX_BUILDDIR)/epub."
444
445 latex:
446 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
447 @echo
448 @echo "Build finished; the LaTeX files are in $(SPHINX_BUILDDIR)/latex."
449 @echo "Run \`make' in that directory to run these through (pdf)latex" \
450 "(use \`make latexpdf' here to do that automatically)."
451
452 latexpdf: latex
453 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
454 @echo "Running LaTeX files through pdflatex..."
455 make -C $(SPHINX_BUILDDIR)/latex all-pdf
456 @echo "pdflatex finished; the PDF files are in $(SPHINX_BUILDDIR)/latex."
457
458 text:
459 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/text
460 @echo
461 @echo "Build finished. The text files are in $(SPHINX_BUILDDIR)/text."
462
463 man:
464 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/man
465 @echo
466 @echo "Build finished. The manual pages are in $(SPHINX_BUILDDIR)/man."
467
468 changes:
469 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/changes
470 @echo
471 @echo "The overview file is in $(SPHINX_BUILDDIR)/changes."
472
473 linkcheck:
474 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/linkcheck
475 @echo
476 @echo "Link check complete; look for any errors in the above output " \
477 "or in $(SPHINX_BUILDDIR)/linkcheck/output.txt."
478
479 doctest:
480 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/doctest
481 @echo "Testing of doctests in the sources finished, look at the " \
482 "results in $(SPHINX_BUILDDIR)/doctest/output.txt."
483 endif