New docs system.
[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/*.rst \
7 docs/_static \
8 docs/_templates \
9 docs/conf.py \
10 docs/libmemcached.rst \
11 docs/libmemcached_examples.rst \
12 docs/libmemcachedutil.rst \
13 docs/memaslap.rst \
14 docs/memcached_analyze.rst \
15 docs/memcached_dump.rst \
16 docs/memcached_flush.rst \
17 docs/memcached_flush_buffers.rst \
18 docs/memcached_generate_hash_value.rst \
19 docs/memcached_quit.rst \
20 docs/memcached_strerror.rst \
21 docs/memcached_verbosity.rst \
22 docs/memcapable.rst \
23 docs/memcat.rst \
24 docs/memcp.rst \
25 docs/memdump.rst \
26 docs/memerror.rst \
27 docs/memflush.rst \
28 docs/memrm.rst \
29 docs/memslap.rst \
30 docs/memstat.rst
31
32 AUTO_PAGES= \
33 memcached_increment.rst \
34 memcached_increment_with_initial.rst \
35 memcached_decrement.rst \
36 memcached_decrement_with_initial.rst
37 BUILT_SOURCES += ${AUTO_PAGES}
38
39 BEHAVIOR_PAGES= \
40 memcached_behavior_get.rst \
41 memcached_behavior_set.rst
42 BUILT_SOURCES += ${BEHAVIOR_PAGES}
43
44 CALLBACK_PAGES= \
45 memcached_callback_get.rst \
46 memcached_callback_set.rst
47 BUILT_SOURCES += ${CALLBACK_PAGES}
48
49 CREATE_PAGES= \
50 memcached_clone.rst \
51 memcached_free.rst \
52 memcached_servers_reset.rst
53 BUILT_SOURCES += ${CREATE_PAGES}
54
55 DELETE_PAGES= \
56 memcached_delete_by_key.rst
57 BUILT_SOURCES += ${DELETE_PAGES}
58
59 GET_PAGES= \
60 memcached_get_by_key.rst \
61 memcached_fetch_result.rst \
62 memcached_fetch_execute.rst \
63 memcached_mget.rst \
64 memcached_mget_by_key.rst \
65 memcached_mget_execute.rst \
66 memcached_mget_execute_by_key.rst \
67 memcached_fetch.rst
68 BUILT_SOURCES += ${GET_PAGES}
69
70 MEMORY_ALLOCATORS_PAGES= \
71 memcached_get_memory_allocators.rst \
72 memcached_set_memory_allocators.rst \
73 memcached_set_memory_allocators_context.rst
74 BUILT_SOURCES += ${MEMORY_ALLOCATORS_PAGES}
75
76 POOL_PAGES= \
77 memcached_pool_behavior_get.rst \
78 memcached_pool_behavior_set.rst \
79 memcached_pool_create.rst \
80 memcached_pool_destroy.rst \
81 memcached_pool_rst.rst \
82 memcached_pool_push.rst
83 BUILT_SOURCES += ${POOL_PAGES}
84
85 RESULT_PAGES= \
86 memcached_result_cas.rst \
87 memcached_result_create.rst \
88 memcached_result_flags.rst \
89 memcached_result_free.rst \
90 memcached_result_key_length.rst \
91 memcached_result_key_value.rst \
92 memcached_result_length.rst \
93 memcached_result_value.rst
94 BUILT_SOURCES += ${RESULT_PAGES}
95
96
97 SERVER_PAGES= \
98 memcached_server_count.rst \
99 memcached_server_cursor.rst \
100 memcached_server_list.rst \
101 memcached_server_add.rst \
102 memcached_server_add_unix_socket.rst \
103 memcached_server_push.rst
104 BUILT_SOURCES += ${SERVER_PAGES}
105
106 SERVER_ST_PAGES= \
107 memcached_server_list_free.rst \
108 memcached_server_list_count.rst \
109 memcached_server_list_append.rst \
110 memcached_servers_parse.rst
111 BUILT_SOURCES += ${SERVER_ST_PAGES}
112
113 SET_PAGES= \
114 memcached_set_by_key.rst \
115 memcached_cas.rst \
116 memcached_cas_by_key.rst \
117 memcached_replace.rst \
118 memcached_replace_by_key.rst \
119 memcached_add.rst \
120 memcached_add_by_key.rst \
121 memcached_prepend.rst \
122 memcached_prepend_by_key.rst \
123 memcached_append.rst \
124 memcached_append_by_key.rst
125 BUILT_SOURCES += ${SET_PAGES}
126
127 STATS_PAGES= \
128 memcached_stat.rst \
129 memcached_stat_execute.rst\
130 memcached_stat_get_keys.rst\
131 memcached_stat_get_value.rst \
132 memcached_stat_servername.rst
133 BUILT_SOURCES += ${STATS_PAGES}
134
135 USER_DATA_PAGES= \
136 memcached_get_user_data.rst \
137 memcached_set_user_data.rst
138 BUILT_SOURCES += ${USER_DATA_PAGES}
139
140 VERSION_PAGES= \
141 memcached_lib_version.rst
142 BUILT_SOURCES += ${VERSION_PAGES}
143
144
145 #
146 # These are for libhashkit
147 #
148 HASHKIT_CREATE_PAGES= \
149 hashkit_is_allocated.rst \
150 hashkit_clone.rst \
151 hashkit_free.rst
152 BUILT_SOURCES += ${HASHKIT_CREATE_PAGES}
153
154 HASHKIT_FUNCTIONS_PAGES= \
155 hashkit_crc32.rst \
156 hashkit_fnv1_32.rst \
157 hashkit_fnv1_64.rst \
158 hashkit_fnv1a_32.rst \
159 hashkit_fnv1a_64.rst \
160 hashkit_hsieh.rst \
161 hashkit_jenkins.rst \
162 hashkit_md5.rst \
163 hashkit_murmur.rst
164 BUILT_SOURCES += ${HASHKIT_FUNCTIONS_PAGES}
165
166 HASHKIT_ST_PAGES= \
167 docs/hashkit_value.rst
168 BUILT_SOURCES += ${HASHKIT_ST_PAGES}
169
170 SASL_PAGES= \
171 memcached_destroy_sasl_auth_data.rst \
172 memcached_get_sasl_callbacks.rst \
173 memcached_sasl_set_auth_data.rst \
174 memcached_set_sasl_callbacks.rst
175 BUILT_SOURCES += ${SASL_PAGES}
176
177
178 # Makefile for Sphinx documentation
179 #
180
181 SPHINXOPTS = ${SPHINX_WARNINGS} -D release=${PANDORA_RELEASE_VERSION}
182 PAPER =
183 SPHINX_BUILDDIR = ${top_builddir}/docs
184
185 # Internal variables.
186 PAPEROPT_a4 = -D latex_paper_size=a4
187 PAPEROPT_letter = -D latex_paper_size=letter
188 ALLSPHINXOPTS = -d $(SPHINX_BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) ${top_srcdir}/docs
189
190 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
191
192 if HAVE_RECENT_SPHINX
193
194 man_MANS+= \
195 docs/man/hashkit_clone.3 \
196 docs/man/hashkit_crc32.3 \
197 docs/man/hashkit_create.3 \
198 docs/man/hashkit_fnv1_32.3 \
199 docs/man/hashkit_fnv1_64.3 \
200 docs/man/hashkit_fnv1a_32.3 \
201 docs/man/hashkit_fnv1a_64.3 \
202 docs/man/hashkit_free.3 \
203 docs/man/hashkit_functions.3 \
204 docs/man/hashkit_hsieh.3 \
205 docs/man/hashkit_is_allocated.3 \
206 docs/man/hashkit_jenkins.3 \
207 docs/man/hashkit_md5.3 \
208 docs/man/hashkit_murmur.3 \
209 docs/man/hashkit_value.3 \
210 docs/man/libmemcached.3 \
211 docs/man/libmemcached_examples.3 \
212 docs/man/memaslap.1 \
213 docs/man/memcached_add.3 \
214 docs/man/memcached_add_by_key.3 \
215 docs/man/memcached_analyze.3 \
216 docs/man/memcached_append.3 \
217 docs/man/memcached_append_by_key.3 \
218 docs/man/memcached_behavior_get.3 \
219 docs/man/memcached_behavior_set.3 \
220 docs/man/memcached_callback_get.3 \
221 docs/man/memcached_callback_set.3 \
222 docs/man/memcached_cas.3 \
223 docs/man/memcached_cas_by_key.3 \
224 docs/man/memcached_clone.3 \
225 docs/man/memcached_create.3 \
226 docs/man/memcached_decrement.3 \
227 docs/man/memcached_decrement_with_initial.3 \
228 docs/man/memcached_delete.3 \
229 docs/man/memcached_delete_by_key.3 \
230 docs/man/memcached_destroy_sasl_auth_data.3 \
231 docs/man/memcached_dump.3 \
232 docs/man/memcached_fetch.3 \
233 docs/man/memcached_fetch_execute.3 \
234 docs/man/memcached_fetch_result.3 \
235 docs/man/memcached_flush_buffers.3 \
236 docs/man/memcached_free.3 \
237 docs/man/memcached_generate_hash_value.3 \
238 docs/man/memcached_get.3 \
239 docs/man/memcached_get_by_key.3 \
240 docs/man/memcached_get_memory_allocators.3 \
241 docs/man/memcached_get_sasl_callbacks.3 \
242 docs/man/memcached_get_user_data.3 \
243 docs/man/memcached_increment.3 \
244 docs/man/memcached_increment_with_initial.3 \
245 docs/man/memcached_lib_version.3 \
246 docs/man/memcached_mget.3 \
247 docs/man/memcached_mget_by_key.3 \
248 docs/man/memcached_mget_execute.3 \
249 docs/man/memcached_mget_execute_by_key.3 \
250 docs/man/memcached_prepend.3 \
251 docs/man/memcached_prepend_by_key.3 \
252 docs/man/memcached_quit.3 \
253 docs/man/memcached_replace.3 \
254 docs/man/memcached_replace_by_key.3 \
255 docs/man/memcached_sasl_set_auth_data.3 \
256 docs/man/memcached_server_add.3 \
257 docs/man/memcached_server_count.3 \
258 docs/man/memcached_server_cursor.3 \
259 docs/man/memcached_server_list.3 \
260 docs/man/memcached_server_list_append.3 \
261 docs/man/memcached_server_list_count.3 \
262 docs/man/memcached_server_list_free.3 \
263 docs/man/memcached_server_push.3 \
264 docs/man/memcached_servers_parse.3 \
265 docs/man/memcached_set.3 \
266 docs/man/memcached_set_by_key.3 \
267 docs/man/memcached_set_memory_allocators.3 \
268 docs/man/memcached_set_sasl_callbacks.3 \
269 docs/man/memcached_set_user_data.3 \
270 docs/man/memcached_stat.3 \
271 docs/man/memcached_stat_execute.3 \
272 docs/man/memcached_stat_get_keys.3 \
273 docs/man/memcached_stat_get_value.3 \
274 docs/man/memcached_stat_servername.3 \
275 docs/man/memcached_strerror.3 \
276 docs/man/memcached_verbosity.3 \
277 docs/man/memcached_version.3 \
278 docs/man/memcapable.1 \
279 docs/man/memcat.1 \
280 docs/man/memcp.1 \
281 docs/man/memdump.1 \
282 docs/man/memerror.1 \
283 docs/man/memflush.1 \
284 docs/man/memrm.1 \
285 docs/man/memslap.1 \
286 docs/man/memstat.1
287
288 DISTCLEANFILES+= \
289 docs/man/hashkit_clone.3 \
290 docs/man/hashkit_crc32.3 \
291 docs/man/hashkit_create.3 \
292 docs/man/hashkit_fnv1_32.3 \
293 docs/man/hashkit_fnv1_64.3 \
294 docs/man/hashkit_fnv1a_32.3 \
295 docs/man/hashkit_fnv1a_64.3 \
296 docs/man/hashkit_free.3 \
297 docs/man/hashkit_functions.3 \
298 docs/man/hashkit_hsieh.3 \
299 docs/man/hashkit_is_allocated.3 \
300 docs/man/hashkit_jenkins.3 \
301 docs/man/hashkit_md5.3 \
302 docs/man/hashkit_murmur.3 \
303 docs/man/hashkit_value.3 \
304 docs/man/libmemcached.3 \
305 docs/man/libmemcached_examples.3 \
306 docs/man/memaslap.1 \
307 docs/man/memcached_add.3 \
308 docs/man/memcached_add_by_key.3 \
309 docs/man/memcached_analyze.3 \
310 docs/man/memcached_append.3 \
311 docs/man/memcached_append_by_key.3 \
312 docs/man/memcached_behavior_get.3 \
313 docs/man/memcached_behavior_set.3 \
314 docs/man/memcached_callback_get.3 \
315 docs/man/memcached_callback_set.3 \
316 docs/man/memcached_cas.3 \
317 docs/man/memcached_cas_by_key.3 \
318 docs/man/memcached_clone.3 \
319 docs/man/memcached_create.3 \
320 docs/man/memcached_decrement.3 \
321 docs/man/memcached_decrement_with_initial.3 \
322 docs/man/memcached_delete.3 \
323 docs/man/memcached_delete_by_key.3 \
324 docs/man/memcached_destroy_sasl_auth_data.3 \
325 docs/man/memcached_dump.3 \
326 docs/man/memcached_fetch.3 \
327 docs/man/memcached_fetch_execute.3 \
328 docs/man/memcached_fetch_result.3 \
329 docs/man/memcached_flush_buffers.3 \
330 docs/man/memcached_free.3 \
331 docs/man/memcached_generate_hash_value.3 \
332 docs/man/memcached_get.3 \
333 docs/man/memcached_get_by_key.3 \
334 docs/man/memcached_get_memory_allocators.3 \
335 docs/man/memcached_get_sasl_callbacks.3 \
336 docs/man/memcached_get_user_data.3 \
337 docs/man/memcached_increment.3 \
338 docs/man/memcached_increment_with_initial.3 \
339 docs/man/memcached_lib_version.3 \
340 docs/man/memcached_mget.3 \
341 docs/man/memcached_mget_by_key.3 \
342 docs/man/memcached_mget_execute.3 \
343 docs/man/memcached_mget_execute_by_key.3 \
344 docs/man/memcached_prepend.3 \
345 docs/man/memcached_prepend_by_key.3 \
346 docs/man/memcached_quit.3 \
347 docs/man/memcached_replace.3 \
348 docs/man/memcached_replace_by_key.3 \
349 docs/man/memcached_sasl_set_auth_data.3 \
350 docs/man/memcached_server_add.3 \
351 docs/man/memcached_server_count.3 \
352 docs/man/memcached_server_cursor.3 \
353 docs/man/memcached_server_list.3 \
354 docs/man/memcached_server_list_append.3 \
355 docs/man/memcached_server_list_count.3 \
356 docs/man/memcached_server_list_free.3 \
357 docs/man/memcached_server_push.3 \
358 docs/man/memcached_servers_parse.3 \
359 docs/man/memcached_set.3 \
360 docs/man/memcached_set_by_key.3 \
361 docs/man/memcached_set_memory_allocators.3 \
362 docs/man/memcached_set_sasl_callbacks.3 \
363 docs/man/memcached_set_user_data.3 \
364 docs/man/memcached_stat.3 \
365 docs/man/memcached_stat_execute.3 \
366 docs/man/memcached_stat_get_keys.3 \
367 docs/man/memcached_stat_get_value.3 \
368 docs/man/memcached_stat_servername.3 \
369 docs/man/memcached_strerror.3 \
370 docs/man/memcached_verbosity.3 \
371 docs/man/memcached_version.3 \
372 docs/man/memcapable.1 \
373 docs/man/memcat.1 \
374 docs/man/memcp.1 \
375 docs/man/memdump.1 \
376 docs/man/memerror.1 \
377 docs/man/memflush.1 \
378 docs/man/memrm.1 \
379 docs/man/memslap.1 \
380 docs/man/memstat.1
381
382 DISTCLEANFILES+= \
383 docs/hashkit_clone.rst \
384 docs/hashkit_crc32.rst \
385 docs/hashkit_fnv1_32.rst \
386 docs/hashkit_fnv1_64.rst \
387 docs/hashkit_fnv1a_32.rst \
388 docs/hashkit_fnv1a_64.rst \
389 docs/hashkit_free.rst \
390 docs/hashkit_hsieh.rst \
391 docs/hashkit_is_allocated.rst \
392 docs/hashkit_jenkins.rst \
393 docs/hashkit_md5.rst \
394 docs/hashkit_murmur.rst \
395 docs/linkcheck/ \
396 docs/memcached_add.rst \
397 docs/memcached_add_by_key.rst \
398 docs/memcached_append.rst \
399 docs/memcached_append_by_key.rst \
400 docs/memcached_behavior_get.rst \
401 docs/memcached_behavior_set.rst \
402 docs/memcached_callback_get.rst \
403 docs/memcached_callback_set.rst \
404 docs/memcached_cas.rst \
405 docs/memcached_cas_by_key.rst \
406 docs/memcached_clone.rst \
407 docs/memcached_decrement.rst \
408 docs/memcached_decrement_with_initial.rst \
409 docs/memcached_delete_by_key.rst \
410 docs/memcached_destroy_sasl_auth_data.rst \
411 docs/memcached_fetch.rst \
412 docs/memcached_fetch_execute.rst \
413 docs/memcached_fetch_result.rst \
414 docs/memcached_free.rst \
415 docs/memcached_get_by_key.rst \
416 docs/memcached_get_memory_allocators.rst \
417 docs/memcached_get_sasl_callbacks.rst \
418 docs/memcached_get_user_data.rst \
419 docs/memcached_increment.rst \
420 docs/memcached_increment_with_initial.rst \
421 docs/memcached_lib_version.rst \
422 docs/memcached_mget.rst \
423 docs/memcached_mget_by_key.rst \
424 docs/memcached_mget_execute.rst \
425 docs/memcached_mget_execute_by_key.rst \
426 docs/memcached_pool_behavior_get.rst \
427 docs/memcached_pool_behavior_set.rst \
428 docs/memcached_pool_create.rst \
429 docs/memcached_pool_destroy.rst \
430 docs/memcached_pool_push.rst \
431 docs/memcached_pool_rst.rst \
432 docs/memcached_prepend.rst \
433 docs/memcached_prepend_by_key.rst \
434 docs/memcached_replace.rst \
435 docs/memcached_replace_by_key.rst \
436 docs/memcached_result_cas.rst \
437 docs/memcached_result_create.rst \
438 docs/memcached_result_flags.rst \
439 docs/memcached_result_free.rst \
440 docs/memcached_result_key_length.rst \
441 docs/memcached_result_key_value.rst \
442 docs/memcached_result_length.rst \
443 docs/memcached_result_value.rst \
444 docs/memcached_sasl_set_auth_data.rst \
445 docs/memcached_server_add.rst \
446 docs/memcached_server_add_unix_socket.rst \
447 docs/memcached_server_count.rst \
448 docs/memcached_server_cursor.rst \
449 docs/memcached_server_list.rst \
450 docs/memcached_server_list_append.rst \
451 docs/memcached_server_list_count.rst \
452 docs/memcached_server_list_free.rst \
453 docs/memcached_server_push.rst \
454 docs/memcached_servers_parse.rst \
455 docs/memcached_servers_reset.rst \
456 docs/memcached_set_by_key.rst \
457 docs/memcached_set_memory_allocators.rst \
458 docs/memcached_set_memory_allocators_context.rst \
459 docs/memcached_set_sasl_callbacks.rst \
460 docs/memcached_set_user_data.rst \
461 docs/memcached_stat.rst \
462 docs/memcached_stat_execute.rst \
463 docs/memcached_stat_get_keys.rst \
464 docs/memcached_stat_get_value.rst \
465 docs/memcached_stat_servername.rst
466
467
468 docs/man/hashkit_clone.3: man
469 docs/man/hashkit_crc32.3: man
470 docs/man/hashkit_create.3: man
471 docs/man/hashkit_fnv1_32.3: man
472 docs/man/hashkit_fnv1_64.3: man
473 docs/man/hashkit_fnv1a_32.3: man
474 docs/man/hashkit_fnv1a_64.3: man
475 docs/man/hashkit_free.3: man
476 docs/man/hashkit_functions.3: man
477 docs/man/hashkit_hsieh.3: man
478 docs/man/hashkit_is_allocated.3: man
479 docs/man/hashkit_jenkins.3: man
480 docs/man/hashkit_md5.3: man
481 docs/man/hashkit_murmur.3: man
482 docs/man/hashkit_value.3: man
483 docs/man/libmemcached.3: man
484 docs/man/libmemcached_examples.3: man
485 docs/man/memaslap.1: man
486 docs/man/memcached_add.3: man
487 docs/man/memcached_add_by_key.3: man
488 docs/man/memcached_analyze.3: man
489 docs/man/memcached_append.3: man
490 docs/man/memcached_append_by_key.3: man
491 docs/man/memcached_behavior_get.3: man
492 docs/man/memcached_behavior_set.3: man
493 docs/man/memcached_callback_get.3: man
494 docs/man/memcached_callback_set.3: man
495 docs/man/memcached_cas.3: man
496 docs/man/memcached_cas_by_key.3: man
497 docs/man/memcached_clone.3: man
498 docs/man/memcached_create.3: man
499 docs/man/memcached_decrement.3: man
500 docs/man/memcached_decrement_with_initial.3: man
501 docs/man/memcached_delete.3: man
502 docs/man/memcached_delete_by_key.3: man
503 docs/man/memcached_destroy_sasl_auth_data.3: man
504 docs/man/memcached_dump.3: man
505 docs/man/memcached_fetch.3: man
506 docs/man/memcached_fetch_execute.3: man
507 docs/man/memcached_fetch_result.3: man
508 docs/man/memcached_flush_buffers.3: man
509 docs/man/memcached_free.3: man
510 docs/man/memcached_generate_hash_value.3: man
511 docs/man/memcached_get.3: man
512 docs/man/memcached_get_by_key.3: man
513 docs/man/memcached_get_memory_allocators.3: man
514 docs/man/memcached_get_sasl_callbacks.3: man
515 docs/man/memcached_get_user_data.3: man
516 docs/man/memcached_increment.3: man
517 docs/man/memcached_increment_with_initial.3: man
518 docs/man/memcached_lib_version.3: man
519 docs/man/memcached_mget.3: man
520 docs/man/memcached_mget_by_key.3: man
521 docs/man/memcached_mget_execute.3: man
522 docs/man/memcached_mget_execute_by_key.3: man
523 docs/man/memcached_prepend.3: man
524 docs/man/memcached_prepend_by_key.3: man
525 docs/man/memcached_quit.3: man
526 docs/man/memcached_replace.3: man
527 docs/man/memcached_replace_by_key.3: man
528 docs/man/memcached_sasl_set_auth_data.3: man
529 docs/man/memcached_server_add.3: man
530 docs/man/memcached_server_count.3: man
531 docs/man/memcached_server_cursor.3: man
532 docs/man/memcached_server_list.3: man
533 docs/man/memcached_server_list_append.3: man
534 docs/man/memcached_server_list_count.3: man
535 docs/man/memcached_server_list_free.3: man
536 docs/man/memcached_server_push.3: man
537 docs/man/memcached_servers_parse.3: man
538 docs/man/memcached_set.3: man
539 docs/man/memcached_set_by_key.3: man
540 docs/man/memcached_set_memory_allocators.3: man
541 docs/man/memcached_set_sasl_callbacks.3: man
542 docs/man/memcached_set_user_data.3: man
543 docs/man/memcached_stat.3: man
544 docs/man/memcached_stat_execute.3: man
545 docs/man/memcached_stat_get_keys.3: man
546 docs/man/memcached_stat_get_value.3: man
547 docs/man/memcached_stat_servername.3: man
548 docs/man/memcached_strerror.3: man
549 docs/man/memcached_verbosity.3: man
550 docs/man/memcached_version.3: man
551 docs/man/memcapable.1: man
552 docs/man/memcat.1: man
553 docs/man/memcp.1: man
554 docs/man/memdump.1: man
555 docs/man/memerror.1: man
556 docs/man/memflush.1: man
557 docs/man/memrm.1: man
558 docs/man/memslap.1: man
559 docs/man/memstat.1: man
560
561 endif
562
563 if HAVE_SPHINX
564 sphinx-help:
565 @echo "Please use \`make <target>' where <target> is one of"
566 @echo " html to make standalone HTML files"
567 @echo " dirhtml to make HTML files named index.html in directories"
568 @echo " singlehtml to make a single large HTML file"
569 @echo " pickle to make pickle files"
570 @echo " json to make JSON files"
571 @echo " htmlhelp to make HTML files and a HTML help project"
572 @echo " qthelp to make HTML files and a qthelp project"
573 @echo " devhelp to make HTML files and a Devhelp project"
574 @echo " epub to make an epub"
575 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
576 @echo " latexpdf to make LaTeX files and run them through pdflatex"
577 @echo " text to make text files"
578 @echo " man to make manual pages"
579 @echo " changes to make an overview of all changed/added/deprecated items"
580 @echo " linkcheck to check all external links for integrity"
581 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
582
583 html-local:
584 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/html
585 @echo
586 @echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/html."
587
588 dirhtml:
589 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/dirhtml
590 @echo
591 @echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/dirhtml."
592
593 singlehtml:
594 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/singlehtml
595 @echo
596 @echo "Build finished. The HTML page is in $(SPHINX_BUILDDIR)/singlehtml."
597
598 pickle:
599 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/pickle
600 @echo
601 @echo "Build finished; now you can process the pickle files."
602
603 json:
604 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/json
605 @echo
606 @echo "Build finished; now you can process the JSON files."
607
608 htmlhelp:
609 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/htmlhelp
610 @echo
611 @echo "Build finished; now you can run HTML Help Workshop with the" \
612 ".hhp project file in $(SPHINX_BUILDDIR)/htmlhelp."
613
614 qthelp:
615 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/qthelp
616 @echo
617 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
618 ".qhcp project file in $(SPHINX_BUILDDIR)/qthelp, like this:"
619 @echo "# qcollectiongenerator $(SPHINX_BUILDDIR)/qthelp/Libmemcached.qhcp"
620 @echo "To view the help file:"
621 @echo "# assistant -collectionFile $(SPHINX_BUILDDIR)/qthelp/Libmemcached.qhc"
622
623 devhelp:
624 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/devhelp
625 @echo
626 @echo "Build finished."
627 @echo "To view the help file:"
628 @echo "# mkdir -p $$HOME/.local/share/devhelp/Libmemcached"
629 @echo "# ln -s $(SPHINX_BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Libmemcached"
630 @echo "# devhelp"
631
632 epub:
633 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/epub
634 @echo
635 @echo "Build finished. The epub file is in $(SPHINX_BUILDDIR)/epub."
636
637 latex:
638 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
639 @echo
640 @echo "Build finished; the LaTeX files are in $(SPHINX_BUILDDIR)/latex."
641 @echo "Run \`make' in that directory to run these through (pdf)latex" \
642 "(use \`make latexpdf' here to do that automatically)."
643
644 latexpdf: latex
645 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
646 @echo "Running LaTeX files through pdflatex..."
647 make -C $(SPHINX_BUILDDIR)/latex all-pdf
648 @echo "pdflatex finished; the PDF files are in $(SPHINX_BUILDDIR)/latex."
649
650 text:
651 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/text
652 @echo
653 @echo "Build finished. The text files are in $(SPHINX_BUILDDIR)/text."
654
655 man:
656 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/man
657 @echo
658 @echo "Build finished. The manual pages are in $(SPHINX_BUILDDIR)/man."
659
660 changes:
661 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/changes
662 @echo
663 @echo "The overview file is in $(SPHINX_BUILDDIR)/changes."
664
665 linkcheck:
666 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/linkcheck
667 @echo
668 @echo "Link check complete; look for any errors in the above output " \
669 "or in $(SPHINX_BUILDDIR)/linkcheck/output.txt."
670
671 doctest:
672 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/doctest
673 @echo "Testing of doctests in the sources finished, look at the " \
674 "results in $(SPHINX_BUILDDIR)/doctest/output.txt."
675 endif
676
677 ${CREATE_PAGES}:
678 @cd docs && rm -f $@
679 @cd docs && cp memcached_create.rst $@
680
681 ${SET_PAGES}:
682 @cd docs && rm -f $@
683 @cd docs && cp memcached_set.rst $@
684
685 ${DELETE_PAGES}:
686 @cd docs && rm -f $@
687 @cd docs && cp memcached_delete.rst $@
688
689 ${AUTO_PAGES}:
690 @cd docs && rm -f $@
691 @cd docs && cp memcached_auto.rst $@
692
693 ${GET_PAGES}:
694 @cd docs && rm -f $@
695 @cd docs && cp memcached_get.rst $@
696
697 ${SERVER_PAGES}:
698 @cd docs && rm -f $@
699 @cd docs && cp memcached_servers.rst $@
700
701 ${SERVER_ST_PAGES}:
702 @cd docs && rm -f $@
703 @cd docs && cp memcached_server_st.rst $@
704
705 ${BEHAVIOR_PAGES}:
706 @cd docs && rm -f $@
707 @cd docs && cp memcached_behavior.rst $@
708
709 ${CALLBACK_PAGES}:
710 @cd docs && rm -f $@
711 @cd docs && cp memcached_callback.rst $@
712
713 ${STATS_PAGES}:
714 @cd docs && rm -f $@
715 @cd docs && cp memcached_stats.rst $@
716
717 ${RESULT_PAGES}:
718 @cd docs && rm -f $@
719 @cd docs && cp memcached_result_st.rst $@
720
721 ${VERSION_PAGES}:
722 @cd docs && rm -f $@
723 @cd docs && cp memcached_version.rst $@
724
725 ${MEMORY_ALLOCATORS_PAGES}:
726 @cd docs && rm -f $@
727 @cd docs && cp memcached_memory_allocators.rst $@
728
729 ${USER_DATA_PAGES}:
730 @cd docs && rm -f $@
731 @cd docs && cp memcached_user_data.rst $@
732
733 ${POOL_PAGES}:
734 @cd docs && rm -f $@
735 @cd docs && cp memcached_pool.rst $@
736
737 ${HASHKIT_CREATE_PAGES}:
738 @cd docs && rm -f $@
739 @cd docs && cp hashkit_create.rst $@
740
741 ${HASHKIT_FUNCTIONS_PAGES}:
742 @cd docs && rm -f $@
743 @cd docs && cp hashkit_functions.rst $@
744
745 ${HASHKIT_ST_PAGES}:
746 @cd docs && rm -f $@
747 @cd docs && cp hashkit_value.rst $@
748
749 ${SASL_PAGES}:
750 @cd docs && rm -f $@
751 @cd docs && cp memcached_sasl.rst $@
752
753