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