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