# included from Top Level Makefile.am
# All paths should be given relative to the root
-EXTRA_DIST+= \
- docs/conf.py
-
# Makefile for Sphinx documentation
#
-SPHINXOPTS = ${SPHINX_WARNINGS} -D release=${PANDORA_RELEASE_VERSION}
+SPHINXOPTS = ${SPHINX_WARNINGS}
PAPER =
SPHINX_BUILDDIR = ${top_builddir}/docs
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
-man_MANS+= \
- docs/man/hashkit_clone.3 \
- docs/man/hashkit_crc32.3 \
- docs/man/hashkit_create.3 \
- docs/man/hashkit_fnv1_32.3 \
- docs/man/hashkit_fnv1_64.3 \
- docs/man/hashkit_fnv1a_32.3 \
- docs/man/hashkit_fnv1a_64.3 \
- docs/man/hashkit_free.3 \
- docs/man/hashkit_functions.3 \
- docs/man/hashkit_hsieh.3 \
- docs/man/hashkit_is_allocated.3 \
- docs/man/hashkit_jenkins.3 \
- docs/man/hashkit_md5.3 \
- docs/man/hashkit_murmur.3 \
- docs/man/hashkit_value.3 \
- docs/man/libhashkit.3 \
- docs/man/libmemcached.3 \
- docs/man/libmemcached_examples.3 \
- docs/man/libmemcachedutil.3 \
- docs/man/memaslap.1 \
- docs/man/memcached_add.3 \
- docs/man/memcached_add_by_key.3 \
- docs/man/memcached_analyze.3 \
- docs/man/memcached_append.3 \
- docs/man/memcached_append_by_key.3 \
- docs/man/memcached_behavior_get.3 \
- docs/man/memcached_behavior_set.3 \
- docs/man/memcached_callback_get.3 \
- docs/man/memcached_callback_set.3 \
- docs/man/memcached_cas.3 \
- docs/man/memcached_cas_by_key.3 \
- docs/man/memcached_clone.3 \
- docs/man/memcached_create.3 \
- docs/man/memcached_decrement.3 \
- docs/man/memcached_decrement_with_initial.3 \
- docs/man/memcached_delete.3 \
- docs/man/memcached_delete_by_key.3 \
- docs/man/memcached_destroy_sasl_auth_data.3 \
- docs/man/memcached_dump.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.3 \
- docs/man/memcached_generate_hash_value.3 \
- docs/man/memcached_get.3 \
- docs/man/memcached_get_by_key.3 \
- docs/man/memcached_get_memory_allocators.3 \
- docs/man/memcached_get_sasl_callbacks.3 \
- docs/man/memcached_get_user_data.3 \
- docs/man/memcached_increment.3 \
- docs/man/memcached_increment_with_initial.3 \
- docs/man/memcached_lib_version.3 \
- docs/man/memcached_mget.3 \
- 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_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_pop.3 \
- docs/man/memcached_pool_push.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_sasl_set_auth_data.3 \
- docs/man/memcached_server_add.3 \
- docs/man/memcached_server_count.3 \
- docs/man/memcached_server_cursor.3 \
- docs/man/memcached_server_list.3 \
- docs/man/memcached_server_list_append.3 \
- docs/man/memcached_server_list_count.3 \
- docs/man/memcached_server_list_free.3 \
- docs/man/memcached_server_push.3 \
- docs/man/memcached_servers_parse.3 \
- docs/man/memcached_set.3 \
- docs/man/memcached_set_by_key.3 \
- docs/man/memcached_set_memory_allocators.3 \
- docs/man/memcached_set_sasl_callbacks.3 \
- docs/man/memcached_set_user_data.3 \
- docs/man/memcached_stat.3 \
- docs/man/memcached_stat_execute.3 \
- docs/man/memcached_stat_get_keys.3 \
- docs/man/memcached_stat_get_value.3 \
- docs/man/memcached_stat_servername.3 \
- docs/man/memcached_strerror.3 \
- docs/man/memcached_verbosity.3 \
- docs/man/memcached_version.3 \
- docs/man/memcapable.1 \
- docs/man/memcat.1 \
- docs/man/memcp.1 \
- docs/man/memdump.1 \
- docs/man/memerror.1 \
- docs/man/memflush.1 \
- docs/man/memrm.1 \
- docs/man/memslap.1 \
- docs/man/memstat.1
-
+man_MANS+= docs/man/hashkit_clone.3
+man_MANS+= docs/man/hashkit_crc32.3
+man_MANS+= docs/man/hashkit_create.3
+man_MANS+= docs/man/hashkit_fnv1_32.3
+man_MANS+= docs/man/hashkit_fnv1_64.3
+man_MANS+= docs/man/hashkit_fnv1a_32.3
+man_MANS+= docs/man/hashkit_fnv1a_64.3
+man_MANS+= docs/man/hashkit_free.3
+man_MANS+= docs/man/hashkit_functions.3
+man_MANS+= docs/man/hashkit_hsieh.3
+man_MANS+= docs/man/hashkit_is_allocated.3
+man_MANS+= docs/man/hashkit_jenkins.3
+man_MANS+= docs/man/hashkit_md5.3
+man_MANS+= docs/man/hashkit_murmur.3
+man_MANS+= docs/man/hashkit_value.3
+man_MANS+= docs/man/libhashkit.3
+man_MANS+= docs/man/libmemcached.3
+man_MANS+= docs/man/libmemcached_examples.3
+man_MANS+= docs/man/libmemcachedutil.3
+man_MANS+= docs/man/memaslap.1
+man_MANS+= docs/man/memcached_add.3
+man_MANS+= docs/man/memcached_add_by_key.3
+man_MANS+= docs/man/memcached_analyze.3
+man_MANS+= docs/man/memcached_append.3
+man_MANS+= docs/man/memcached_append_by_key.3
+man_MANS+= docs/man/memcached_behavior_get.3
+man_MANS+= docs/man/memcached_behavior_set.3
+man_MANS+= docs/man/memcached_callback_get.3
+man_MANS+= docs/man/memcached_callback_set.3
+man_MANS+= docs/man/memcached_cas.3
+man_MANS+= docs/man/memcached_cas_by_key.3
+man_MANS+= docs/man/memcached_clone.3
+man_MANS+= docs/man/memcached_create.3
+man_MANS+= docs/man/memcached_decrement.3
+man_MANS+= docs/man/memcached_decrement_with_initial.3
+man_MANS+= docs/man/memcached_delete.3
+man_MANS+= docs/man/memcached_delete_by_key.3
+man_MANS+= docs/man/libmemcached_check_configuration.3
+man_MANS+= docs/man/libmemcached_configuration.3
+man_MANS+= docs/man/memcached.3
+man_MANS+= docs/man/memcached_destroy_sasl_auth_data.3
+man_MANS+= docs/man/memcached_dump.3
+man_MANS+= docs/man/memcached_exist.3
+man_MANS+= docs/man/memcached_exist_by_key.3
+man_MANS+= docs/man/memcached_fetch.3
+man_MANS+= docs/man/memcached_fetch_execute.3
+man_MANS+= docs/man/memcached_fetch_result.3
+man_MANS+= docs/man/memcached_flush_buffers.3
+man_MANS+= docs/man/memcached_free.3
+man_MANS+= docs/man/memcached_generate_hash.3
+man_MANS+= docs/man/memcached_generate_hash_value.3
+man_MANS+= docs/man/memcached_get.3
+man_MANS+= docs/man/memcached_get_by_key.3
+man_MANS+= docs/man/memcached_get_memory_allocators.3
+man_MANS+= docs/man/memcached_get_sasl_callbacks.3
+man_MANS+= docs/man/memcached_get_user_data.3
+man_MANS+= docs/man/memcached_increment.3
+man_MANS+= docs/man/memcached_increment_with_initial.3
+man_MANS+= docs/man/memcached_lib_version.3
+man_MANS+= docs/man/memcached_mget.3
+man_MANS+= docs/man/memcached_mget_by_key.3
+man_MANS+= docs/man/memcached_mget_execute.3
+man_MANS+= docs/man/memcached_mget_execute_by_key.3
+man_MANS+= docs/man/memcached_pool.3
+man_MANS+= docs/man/memcached_pool_behavior_get.3
+man_MANS+= docs/man/memcached_pool_behavior_set.3
+man_MANS+= docs/man/memcached_pool_create.3
+man_MANS+= docs/man/memcached_pool_destroy.3
+man_MANS+= docs/man/memcached_pool_fetch.3
+man_MANS+= docs/man/memcached_pool_pop.3
+man_MANS+= docs/man/memcached_pool_push.3
+man_MANS+= docs/man/memcached_pool_release.3
+man_MANS+= docs/man/memcached_pool_st.3
+man_MANS+= docs/man/memcached_prepend.3
+man_MANS+= docs/man/memcached_prepend_by_key.3
+man_MANS+= docs/man/memcached_quit.3
+man_MANS+= docs/man/memcached_replace.3
+man_MANS+= docs/man/memcached_replace_by_key.3
+man_MANS+= docs/man/memcached_last_error_message.3
+man_MANS+= docs/man/memcached_sasl_set_auth_data.3
+man_MANS+= docs/man/memcached_server_add.3
+man_MANS+= docs/man/memcached_server_count.3
+man_MANS+= docs/man/memcached_server_cursor.3
+man_MANS+= docs/man/memcached_server_list.3
+man_MANS+= docs/man/memcached_server_list_append.3
+man_MANS+= docs/man/memcached_server_list_count.3
+man_MANS+= docs/man/memcached_server_list_free.3
+man_MANS+= docs/man/memcached_server_push.3
+man_MANS+= docs/man/memcached_servers_parse.3
+man_MANS+= docs/man/memcached_set.3
+man_MANS+= docs/man/memcached_set_by_key.3
+man_MANS+= docs/man/memcached_set_memory_allocators.3
+man_MANS+= docs/man/memcached_set_sasl_callbacks.3
+man_MANS+= docs/man/memcached_set_user_data.3
+man_MANS+= docs/man/memcached_stat.3
+man_MANS+= docs/man/memcached_stat_execute.3
+man_MANS+= docs/man/memcached_stat_get_keys.3
+man_MANS+= docs/man/memcached_stat_get_value.3
+man_MANS+= docs/man/memcached_stat_servername.3
+man_MANS+= docs/man/memcached_strerror.3
+man_MANS+= docs/man/memcached_touch.3
+man_MANS+= docs/man/memcached_touch_by_key.3
+man_MANS+= docs/man/memcached_verbosity.3
+man_MANS+= docs/man/memcached_version.3
+man_MANS+= docs/man/memcapable.1
+man_MANS+= docs/man/memexist.1
+man_MANS+= docs/man/memparse.1
+man_MANS+= docs/man/memping.1
+man_MANS+= docs/man/memcat.1
+man_MANS+= docs/man/memcp.1
+man_MANS+= docs/man/memdump.1
+man_MANS+= docs/man/memtouch.1
+man_MANS+= docs/man/memerror.1
+man_MANS+= docs/man/memflush.1
+man_MANS+= docs/man/memrm.1
+man_MANS+= docs/man/memslap.1
+man_MANS+= docs/man/memstat.1
if HAVE_SPHINX
+
+docs: html man
+
sphinx-help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
-html-local:
+install-html: html-local
+ @rm -r -f /var/www/libmemcached/*
+ @cp -r docs/html /var/www/libmemcached
+
+docs/_static:
+ @$(mkdir_p) docs/_static
+
+html-local: docs/conf.py docs changes docs/_static
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: html-local
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: html-local
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" \
@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."
@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 " \
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."
+
+else
+
+docs:
+
endif
projects / awesomized / libmemcached / blobdiff