git.m6w6.name Git - m6w6/libmemcached/blob - 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              docs/hashkit_clone.rst \
  10              docs/hashkit_crc32.rst \
  11              docs/hashkit_create.rst \
  12              docs/hashkit_fnv1_32.rst \
  13              docs/hashkit_fnv1_64.rst \
  14              docs/hashkit_fnv1a_32.rst \
  15              docs/hashkit_fnv1a_64.rst \
  16              docs/hashkit_free.rst \
  17              docs/hashkit_functions.rst \
  18              docs/hashkit_hsieh.rst \
  19              docs/hashkit_is_allocated.rst \
  20              docs/hashkit_jenkins.rst \
  21              docs/hashkit_md5.rst \
  22              docs/hashkit_murmur.rst \
  23              docs/hashkit_value.rst \
  24              docs/index.rst \
  25              docs/libhashkit.rst \
  26              docs/libmemcached.rst \
  27              docs/libmemcached_examples.rst \
  28              docs/libmemcachedutil.rst \
  29              docs/memaslap.rst \
  30              docs/memcached_add.rst \
  31              docs/memcached_add_by_key.rst \
  32              docs/memcached_analyze.rst \
  33              docs/memcached_append.rst \
  34              docs/memcached_append_by_key.rst \
  35              docs/memcached_auto.rst \
  36              docs/memcached_behavior.rst \
  37              docs/memcached_behavior_get.rst \
  38              docs/memcached_behavior_set.rst \
  39              docs/memcached_callback.rst \
  40              docs/memcached_callback_get.rst \
  41              docs/memcached_callback_set.rst \
  42              docs/memcached_cas.rst \
  43              docs/memcached_cas_by_key.rst \
  44              docs/memcached_clone.rst \
  45              docs/memcached_create.rst \
  46              docs/memcached_decrement.rst \
  47              docs/memcached_decrement_with_initial.rst \
  48              docs/memcached_delete.rst \
  49              docs/memcached_delete_by_key.rst \
  50              docs/memcached_destroy_sasl_auth_data.rst \
  51              docs/memcached_dump.rst \
  52              docs/memcached_fetch.rst \
  53              docs/memcached_fetch_execute.rst \
  54              docs/memcached_fetch_result.rst \
  55              docs/memcached_flush.rst \
  56              docs/memcached_flush_buffers.rst \
  57              docs/memcached_free.rst \
  58              docs/memcached_generate_hash_value.rst \
  59              docs/memcached_get.rst \
  60              docs/memcached_get_by_key.rst \
  61              docs/memcached_get_memory_allocators.rst \
  62              docs/memcached_get_sasl_callbacks.rst \
  63              docs/memcached_get_user_data.rst \
  64              docs/memcached_increment.rst \
  65              docs/memcached_increment_with_initial.rst \
  66              docs/memcached_lib_version.rst \
  67              docs/memcached_memory_allocators.rst \
  68              docs/memcached_mget.rst \
  69              docs/memcached_mget_by_key.rst \
  70              docs/memcached_mget_execute.rst \
  71              docs/memcached_mget_execute_by_key.rst \
  72              docs/memcached_pool.rst \
  73              docs/memcached_pool_behavior_get.rst \
  74              docs/memcached_pool_behavior_set.rst \
  75              docs/memcached_pool_create.rst \
  76              docs/memcached_pool_destroy.rst \
  77              docs/memcached_pool_push.rst \
  78              docs/memcached_pool_rst.rst \
  79              docs/memcached_prepend.rst \
  80              docs/memcached_prepend_by_key.rst \
  81              docs/memcached_quit.rst \
  82              docs/memcached_replace.rst \
  83              docs/memcached_replace_by_key.rst \
  84              docs/memcached_result_cas.rst \
  85              docs/memcached_result_create.rst \
  86              docs/memcached_result_flags.rst \
  87              docs/memcached_result_free.rst \
  88              docs/memcached_result_key_length.rst \
  89              docs/memcached_result_key_value.rst \
  90              docs/memcached_result_length.rst \
  91              docs/memcached_result_st.rst \
  92              docs/memcached_result_value.rst \
  93              docs/memcached_sasl.rst \
  94              docs/memcached_sasl_set_auth_data.rst \
  95              docs/memcached_server_add.rst \
  96              docs/memcached_server_add_unix_socket.rst \
  97              docs/memcached_server_count.rst \
  98              docs/memcached_server_cursor.rst \
  99              docs/memcached_server_list.rst \
 100              docs/memcached_server_list_append.rst \
 101              docs/memcached_server_list_count.rst \
 102              docs/memcached_server_list_free.rst \
 103              docs/memcached_server_push.rst \
 104              docs/memcached_server_st.rst \
 105              docs/memcached_servers.rst \
 106              docs/memcached_servers_parse.rst \
 107              docs/memcached_servers_reset.rst \
 108              docs/memcached_set.rst \
 109              docs/memcached_set_by_key.rst \
 110              docs/memcached_set_memory_allocators.rst \
 111              docs/memcached_set_memory_allocators_context.rst \
 112              docs/memcached_set_sasl_callbacks.rst \
 113              docs/memcached_set_user_data.rst \
 114              docs/memcached_stat.rst \
 115              docs/memcached_stat_execute.rst \
 116              docs/memcached_stat_get_keys.rst \
 117              docs/memcached_stat_get_value.rst \
 118              docs/memcached_stat_servername.rst \
 119              docs/memcached_stats.rst \
 120              docs/memcached_strerror.rst \
 121              docs/memcached_user_data.rst \
 122              docs/memcached_verbosity.rst \
 123              docs/memcached_version.rst \
 124              docs/memcapable.rst \
 125              docs/memcat.rst \
 126              docs/memcp.rst \
 127              docs/memdump.rst \
 128              docs/memerror.rst \
 129              docs/memflush.rst \
 130              docs/memrm.rst \
 131              docs/memslap.rst \
 132              docs/memstat.rst
 133
 134 # Makefile for Sphinx documentation
 135 #
 136
 137 SPHINXOPTS    = ${SPHINX_WARNINGS} -D release=${PANDORA_RELEASE_VERSION}
 138 PAPER         =
 139 SPHINX_BUILDDIR      = ${top_builddir}/docs
 140
 141 # Internal variables.
 142 PAPEROPT_a4     = -D latex_paper_size=a4
 143 PAPEROPT_letter = -D latex_paper_size=letter
 144 ALLSPHINXOPTS   = -d $(SPHINX_BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) ${top_srcdir}/docs
 145
 146 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
 147
 148 man_MANS+= \
 149            docs/man/hashkit_clone.3 \
 150            docs/man/hashkit_crc32.3 \
 151            docs/man/hashkit_create.3 \
 152            docs/man/hashkit_fnv1_32.3 \
 153            docs/man/hashkit_fnv1_64.3 \
 154            docs/man/hashkit_fnv1a_32.3 \
 155            docs/man/hashkit_fnv1a_64.3 \
 156            docs/man/hashkit_free.3 \
 157            docs/man/hashkit_functions.3 \
 158            docs/man/hashkit_hsieh.3 \
 159            docs/man/hashkit_is_allocated.3 \
 160            docs/man/hashkit_jenkins.3 \
 161            docs/man/hashkit_md5.3 \
 162            docs/man/hashkit_murmur.3 \
 163            docs/man/hashkit_value.3 \
 164            docs/man/libhashkit.3 \
 165            docs/man/libmemcached.3 \
 166            docs/man/libmemcached_examples.3 \
 167            docs/man/libmemcachedutil.3 \
 168            docs/man/memaslap.1 \
 169            docs/man/memcached_add.3 \
 170            docs/man/memcached_add_by_key.3 \
 171            docs/man/memcached_analyze.3 \
 172            docs/man/memcached_append.3 \
 173            docs/man/memcached_append_by_key.3 \
 174            docs/man/memcached_behavior_get.3 \
 175            docs/man/memcached_behavior_set.3 \
 176            docs/man/memcached_callback_get.3 \
 177            docs/man/memcached_callback_set.3 \
 178            docs/man/memcached_cas.3 \
 179            docs/man/memcached_cas_by_key.3 \
 180            docs/man/memcached_clone.3 \
 181            docs/man/memcached_create.3 \
 182            docs/man/memcached_decrement.3 \
 183            docs/man/memcached_decrement_with_initial.3 \
 184            docs/man/memcached_delete.3 \
 185            docs/man/memcached_delete_by_key.3 \
 186            docs/man/memcached_destroy_sasl_auth_data.3 \
 187            docs/man/memcached_dump.3 \
 188            docs/man/memcached_fetch.3 \
 189            docs/man/memcached_fetch_execute.3 \
 190            docs/man/memcached_fetch_result.3 \
 191            docs/man/memcached_flush_buffers.3 \
 192            docs/man/memcached_free.3 \
 193            docs/man/memcached_generate_hash_value.3 \
 194            docs/man/memcached_get.3 \
 195            docs/man/memcached_get_by_key.3 \
 196            docs/man/memcached_get_memory_allocators.3 \
 197            docs/man/memcached_get_sasl_callbacks.3 \
 198            docs/man/memcached_get_user_data.3 \
 199            docs/man/memcached_increment.3 \
 200            docs/man/memcached_increment_with_initial.3 \
 201            docs/man/memcached_lib_version.3 \
 202            docs/man/memcached_mget.3 \
 203            docs/man/memcached_mget_by_key.3 \
 204            docs/man/memcached_mget_execute.3  \
 205            docs/man/memcached_mget_execute_by_key.3  \
 206            docs/man/memcached_pool_behavior_get.3 \
 207            docs/man/memcached_pool_behavior_set.3 \
 208            docs/man/memcached_pool_create.3 \
 209            docs/man/memcached_pool_destroy.3 \
 210            docs/man/memcached_pool_pop.3 \
 211            docs/man/memcached_pool_push.3 \
 212            docs/man/memcached_prepend.3 \
 213            docs/man/memcached_prepend_by_key.3 \
 214            docs/man/memcached_quit.3 \
 215            docs/man/memcached_replace.3 \
 216            docs/man/memcached_replace_by_key.3 \
 217            docs/man/memcached_sasl_set_auth_data.3 \
 218            docs/man/memcached_server_add.3 \
 219            docs/man/memcached_server_count.3 \
 220            docs/man/memcached_server_cursor.3 \
 221            docs/man/memcached_server_list.3 \
 222            docs/man/memcached_server_list_append.3 \
 223            docs/man/memcached_server_list_count.3 \
 224            docs/man/memcached_server_list_free.3 \
 225            docs/man/memcached_server_push.3 \
 226            docs/man/memcached_servers_parse.3 \
 227            docs/man/memcached_set.3 \
 228            docs/man/memcached_set_by_key.3 \
 229            docs/man/memcached_set_memory_allocators.3 \
 230            docs/man/memcached_set_sasl_callbacks.3 \
 231            docs/man/memcached_set_user_data.3 \
 232            docs/man/memcached_stat.3 \
 233            docs/man/memcached_stat_execute.3 \
 234            docs/man/memcached_stat_get_keys.3 \
 235            docs/man/memcached_stat_get_value.3 \
 236            docs/man/memcached_stat_servername.3 \
 237            docs/man/memcached_strerror.3 \
 238            docs/man/memcached_verbosity.3 \
 239            docs/man/memcached_version.3 \
 240            docs/man/memcapable.1 \
 241            docs/man/memcat.1 \
 242            docs/man/memcp.1 \
 243            docs/man/memdump.1 \
 244            docs/man/memerror.1 \
 245            docs/man/memflush.1 \
 246            docs/man/memrm.1 \
 247            docs/man/memslap.1 \
 248            docs/man/memstat.1
 249
 250
 251 if HAVE_SPHINX
 252 sphinx-help:
 253         @echo "Please use \`make <target>' where <target> is one of"
 254         @echo "  html       to make standalone HTML files"
 255         @echo "  dirhtml    to make HTML files named index.html in directories"
 256         @echo "  singlehtml to make a single large HTML file"
 257         @echo "  pickle     to make pickle files"
 258         @echo "  json       to make JSON files"
 259         @echo "  htmlhelp   to make HTML files and a HTML help project"
 260         @echo "  qthelp     to make HTML files and a qthelp project"
 261         @echo "  devhelp    to make HTML files and a Devhelp project"
 262         @echo "  epub       to make an epub"
 263         @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
 264         @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
 265         @echo "  text       to make text files"
 266         @echo "  man        to make manual pages"
 267         @echo "  changes    to make an overview of all changed/added/deprecated items"
 268         @echo "  linkcheck  to check all external links for integrity"
 269         @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
 270
 271 html-local:
 272         PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/html
 273         @echo
 274         @echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/html."
 275
 276 dirhtml:
 277         PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/dirhtml
 278         @echo
 279         @echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/dirhtml."
 280
 281 singlehtml:
 282         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/singlehtml
 283         @echo
 284         @echo "Build finished. The HTML page is in $(SPHINX_BUILDDIR)/singlehtml."
 285
 286 pickle:
 287         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/pickle
 288         @echo
 289         @echo "Build finished; now you can process the pickle files."
 290
 291 json:
 292         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/json
 293         @echo
 294         @echo "Build finished; now you can process the JSON files."
 295
 296 htmlhelp:
 297         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/htmlhelp
 298         @echo
 299         @echo "Build finished; now you can run HTML Help Workshop with the" \
 300               ".hhp project file in $(SPHINX_BUILDDIR)/htmlhelp."
 301
 302 qthelp:
 303         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/qthelp
 304         @echo
 305         @echo "Build finished; now you can run "qcollectiongenerator" with the" \
 306               ".qhcp project file in $(SPHINX_BUILDDIR)/qthelp, like this:"
 307         @echo "# qcollectiongenerator $(SPHINX_BUILDDIR)/qthelp/Libmemcached.qhcp"
 308         @echo "To view the help file:"
 309         @echo "# assistant -collectionFile $(SPHINX_BUILDDIR)/qthelp/Libmemcached.qhc"
 310
 311 devhelp:
 312         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/devhelp
 313         @echo
 314         @echo "Build finished."
 315         @echo "To view the help file:"
 316         @echo "# mkdir -p $$HOME/.local/share/devhelp/Libmemcached"
 317         @echo "# ln -s $(SPHINX_BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Libmemcached"
 318         @echo "# devhelp"
 319
 320 epub:
 321         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/epub
 322         @echo
 323         @echo "Build finished. The epub file is in $(SPHINX_BUILDDIR)/epub."
 324
 325 latex:
 326         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
 327         @echo
 328         @echo "Build finished; the LaTeX files are in $(SPHINX_BUILDDIR)/latex."
 329         @echo "Run \`make' in that directory to run these through (pdf)latex" \
 330               "(use \`make latexpdf' here to do that automatically)."
 331
 332 latexpdf: latex
 333         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
 334         @echo "Running LaTeX files through pdflatex..."
 335         make -C $(SPHINX_BUILDDIR)/latex all-pdf
 336         @echo "pdflatex finished; the PDF files are in $(SPHINX_BUILDDIR)/latex."
 337
 338 text:
 339         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/text
 340         @echo
 341         @echo "Build finished. The text files are in $(SPHINX_BUILDDIR)/text."
 342
 343 man:
 344         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/man
 345         @echo
 346         @echo "Build finished. The manual pages are in $(SPHINX_BUILDDIR)/man."
 347
 348 changes:
 349         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/changes
 350         @echo
 351         @echo "The overview file is in $(SPHINX_BUILDDIR)/changes."
 352
 353 linkcheck:
 354         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/linkcheck
 355         @echo
 356         @echo "Link check complete; look for any errors in the above output " \
 357               "or in $(SPHINX_BUILDDIR)/linkcheck/output.txt."
 358
 359 doctest:
 360         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/doctest
 361         @echo "Testing of doctests in the sources finished, look at the " \
 362               "results in $(SPHINX_BUILDDIR)/doctest/output.txt."
 363 endif