X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Finclude.am;h=fd1cb592d547fd00945f4f5907863f94056232c8;hb=ec18b17736a6e0ce98994daf5a6576e9658e4a1d;hp=37ea156561f2ebdd3e546af113fa3d786dd89c6b;hpb=55cf7c68679083cdd7351db3b888c6f8ddcebe09;p=m6w6%2Flibmemcached diff --git a/docs/include.am b/docs/include.am index 37ea1565..fd1cb592 100644 --- a/docs/include.am +++ b/docs/include.am @@ -2,57 +2,10 @@ # included from Top Level Makefile.am # All paths should be given relative to the root -EXTRA_DIST+= \ - docs/conf.py \ - docs/hashkit_create.rst \ - docs/hashkit_functions.rst \ - docs/hashkit_value.rst \ - docs/index.rst \ - docs/libhashkit.rst \ - docs/libmemcached.rst \ - docs/libmemcached_configuration.rst \ - docs/libmemcached_examples.rst \ - docs/libmemcachedutil.rst \ - docs/memaslap.rst \ - docs/memcached_analyze.rst \ - docs/memcached_auto.rst \ - docs/memcached_behavior.rst \ - docs/memcached_callback.rst \ - docs/memcached_create.rst \ - docs/memcached_delete.rst \ - docs/memcached_dump.rst \ - docs/memcached_flush.rst \ - docs/memcached_flush_buffers.rst \ - docs/memcached_generate_hash_value.rst \ - docs/memcached_get.rst \ - docs/memcached_memory_allocators.rst \ - docs/memcached_pool.rst \ - docs/memcached_quit.rst \ - docs/memcached_result_st.rst \ - docs/memcached_sasl.rst \ - docs/memcached_server_st.rst \ - docs/memcached_servers.rst \ - docs/memcached_set.rst \ - docs/memcached_stats.rst \ - docs/memcached_strerror.rst \ - docs/memcached_user_data.rst \ - docs/memcached_verbosity.rst \ - docs/memcached_version.rst \ - docs/memcapable.rst \ - docs/memcat.rst \ - docs/memcp.rst \ - docs/memdump.rst \ - docs/memerror.rst \ - docs/memflush.rst \ - docs/memrm.rst \ - docs/memslap.rst \ - docs/memstat.rst \ - docs/tap.rst - # Makefile for Sphinx documentation # -SPHINXOPTS = ${SPHINX_WARNINGS} -D release=${PANDORA_RELEASE_VERSION} +SPHINXOPTS = ${SPHINX_WARNINGS} PAPER = SPHINX_BUILDDIR = ${top_builddir}/docs @@ -101,17 +54,19 @@ man_MANS+= \ docs/man/memcached_decrement_with_initial.3 \ docs/man/memcached_delete.3 \ docs/man/memcached_delete_by_key.3 \ + docs/man/libmemcached_check_configuration.3 \ + docs/man/libmemcached_configuration.3 \ + docs/man/memcached.3 \ docs/man/memcached_destroy_sasl_auth_data.3 \ docs/man/memcached_dump.3 \ + docs/man/memcached_exist.3 \ + docs/man/memcached_exist_by_key.3 \ docs/man/memcached_fetch.3 \ docs/man/memcached_fetch_execute.3 \ docs/man/memcached_fetch_result.3 \ docs/man/memcached_flush_buffers.3 \ docs/man/memcached_free.3 \ docs/man/memcached_generate_hash.3 \ - docs/man/libmemcached_check_configuration.3 \ - docs/man/libmemcached_configuration.3 \ - docs/man/memcached_create_with_options.3 \ docs/man/memcached_generate_hash_value.3 \ docs/man/memcached_get.3 \ docs/man/memcached_get_by_key.3 \ @@ -125,18 +80,22 @@ man_MANS+= \ docs/man/memcached_mget_by_key.3 \ docs/man/memcached_mget_execute.3 \ docs/man/memcached_mget_execute_by_key.3 \ + docs/man/memcached_pool.3 \ docs/man/memcached_pool_behavior_get.3 \ docs/man/memcached_pool_behavior_set.3 \ docs/man/memcached_pool_create.3 \ docs/man/memcached_pool_destroy.3 \ + docs/man/memcached_pool_fetch.3 \ docs/man/memcached_pool_pop.3 \ docs/man/memcached_pool_push.3 \ + docs/man/memcached_pool_release.3 \ docs/man/memcached_pool_st.3 \ docs/man/memcached_prepend.3 \ docs/man/memcached_prepend_by_key.3 \ docs/man/memcached_quit.3 \ docs/man/memcached_replace.3 \ docs/man/memcached_replace_by_key.3 \ + docs/man/memcached_last_error_message.3 \ docs/man/memcached_sasl_set_auth_data.3 \ docs/man/memcached_server_add.3 \ docs/man/memcached_server_count.3 \ @@ -158,6 +117,8 @@ man_MANS+= \ docs/man/memcached_stat_get_value.3 \ docs/man/memcached_stat_servername.3 \ docs/man/memcached_strerror.3 \ + docs/man/memcached_touch.3 \ + docs/man/memcached_touch_by_key.3 \ docs/man/memcached_verbosity.3 \ docs/man/memcached_version.3 \ docs/man/memcapable.1 \ @@ -170,7 +131,6 @@ man_MANS+= \ docs/man/memslap.1 \ docs/man/memstat.1 - if HAVE_SPHINX sphinx-help: @echo "Please use \`make ' where is one of" @@ -191,38 +151,38 @@ sphinx-help: @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" -html-local: +html-local: docs/conf.py changes PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/html." -dirhtml: +dirhtml: docs/conf.py changes PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/dirhtml @echo @echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/dirhtml." -singlehtml: +singlehtml: docs/conf.py changes PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/singlehtml @echo @echo "Build finished. The HTML page is in $(SPHINX_BUILDDIR)/singlehtml." -pickle: +pickle: docs/conf.py changes PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/pickle @echo @echo "Build finished; now you can process the pickle files." -json: +json: docs/conf.py changes PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/json @echo @echo "Build finished; now you can process the JSON files." -htmlhelp: +htmlhelp: docs/conf.py changes PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in $(SPHINX_BUILDDIR)/htmlhelp." -qthelp: +qthelp: docs/conf.py changes PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/qthelp @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ @@ -231,7 +191,7 @@ qthelp: @echo "To view the help file:" @echo "# assistant -collectionFile $(SPHINX_BUILDDIR)/qthelp/Libmemcached.qhc" -devhelp: +devhelp: docs/conf.py changes PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/devhelp @echo @echo "Build finished." @@ -240,40 +200,40 @@ devhelp: @echo "# ln -s $(SPHINX_BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Libmemcached" @echo "# devhelp" -epub: +epub: docs/conf.py changes PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/epub @echo @echo "Build finished. The epub file is in $(SPHINX_BUILDDIR)/epub." -latex: +latex: docs/conf.py changes PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(SPHINX_BUILDDIR)/latex." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." -latexpdf: latex +latexpdf: latex changes PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." make -C $(SPHINX_BUILDDIR)/latex all-pdf @echo "pdflatex finished; the PDF files are in $(SPHINX_BUILDDIR)/latex." -text: +text: docs/conf.py changes PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/text @echo @echo "Build finished. The text files are in $(SPHINX_BUILDDIR)/text." -man: +man: docs/conf.py changes PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/man @echo @echo "Build finished. The manual pages are in $(SPHINX_BUILDDIR)/man." -changes: +changes: docs/conf.py linkcheck PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/changes @echo @echo "The overview file is in $(SPHINX_BUILDDIR)/changes." -linkcheck: +linkcheck: docs/conf.py PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ @@ -283,4 +243,5 @@ doctest: PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(SPHINX_BUILDDIR)/doctest/output.txt." + endif