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