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