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