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