From f2a59b728c20f7fe78874dd41187ab3fb2db6c7e Mon Sep 17 00:00:00 2001 From: Brian Aker Date: Sun, 16 Feb 2014 01:06:40 -0800 Subject: [PATCH] Fix for building docs. --- Makefile.am | 13 +- configure.ac | 2 +- docs/Makefile | 200 ++++++++++++++++++ docs/include.am | 101 --------- docs/{ => source}/bin/memaslap.rst | 0 docs/{ => source}/bin/memcapable.rst | 0 docs/{ => source}/bin/memcat.rst | 0 docs/{ => source}/bin/memcp.rst | 0 docs/{ => source}/bin/memdump.rst | 0 docs/{ => source}/bin/memerror.rst | 0 docs/{ => source}/bin/memexist.rst | 0 docs/{ => source}/bin/memflush.rst | 0 docs/{ => source}/bin/memparse.rst | 0 docs/{ => source}/bin/memping.rst | 0 docs/{ => source}/bin/memrm.rst | 0 docs/{ => source}/bin/memslap.rst | 0 docs/{ => source}/bin/memstat.rst | 0 docs/{ => source}/bin/memtouch.rst | 0 .../client_errors/MEMCACHED_AUTH_CONTINUE.rst | 0 .../client_errors/MEMCACHED_AUTH_FAILURE.rst | 0 .../client_errors/MEMCACHED_AUTH_PROBLEM.rst | 0 .../MEMCACHED_BAD_KEY_PROVIDED.rst | 0 .../client_errors/MEMCACHED_BUFFERED.rst | 0 .../client_errors/MEMCACHED_CLIENT_ERROR.rst | 0 .../MEMCACHED_CONNECTION_BIND_FAILURE.rst | 0 .../MEMCACHED_CONNECTION_FAILURE.rst | 0 ...ACHED_CONNECTION_SOCKET_CREATE_FAILURE.rst | 0 .../MEMCACHED_DATA_DOES_NOT_EXIST.rst | 0 .../client_errors/MEMCACHED_DATA_EXISTS.rst | 0 .../client_errors/MEMCACHED_DELETED.rst | 0 .../client_errors/MEMCACHED_DEPRECATED.rst | 0 .../client_errors/MEMCACHED_E2BIG.rst | 0 .../client_errors/MEMCACHED_END.rst | 0 .../client_errors/MEMCACHED_ERRNO.rst | 0 .../client_errors/MEMCACHED_FAILURE.rst | 0 .../MEMCACHED_FAIL_UNIX_SOCKET.rst | 0 .../MEMCACHED_FETCH_NOTFINISHED.rst | 0 .../MEMCACHED_HOST_LOOKUP_FAILURE.rst | 0 .../MEMCACHED_INVALID_ARGUMENTS.rst | 0 .../MEMCACHED_INVALID_HOST_PROTOCOL.rst | 0 .../client_errors/MEMCACHED_ITEM.rst | 0 .../client_errors/MEMCACHED_KEY_TOO_BIG.rst | 0 .../MEMCACHED_MAXIMUM_RETURN.rst | 0 .../MEMCACHED_MEMORY_ALLOCATION_FAILURE.rst | 0 .../client_errors/MEMCACHED_NOTFOUND.rst | 0 .../client_errors/MEMCACHED_NOTSTORED.rst | 0 .../client_errors/MEMCACHED_NOT_SUPPORTED.rst | 0 .../MEMCACHED_NO_KEY_PROVIDED.rst | 0 .../client_errors/MEMCACHED_NO_SERVERS.rst | 0 .../client_errors/MEMCACHED_PARSE_ERROR.rst | 0 .../MEMCACHED_PARSE_USER_ERROR.rst | 0 .../client_errors/MEMCACHED_PARTIAL_READ.rst | 0 .../MEMCACHED_PROTOCOL_ERROR.rst | 0 .../client_errors/MEMCACHED_READ_FAILURE.rst | 0 .../client_errors/MEMCACHED_SERVER_ERROR.rst | 0 .../MEMCACHED_SERVER_MARKED_DEAD.rst | 0 .../client_errors/MEMCACHED_SOME_ERRORS.rst | 0 .../client_errors/MEMCACHED_STAT.rst | 0 .../client_errors/MEMCACHED_STORED.rst | 0 .../client_errors/MEMCACHED_SUCCESS.rst | 0 .../client_errors/MEMCACHED_TIMEOUT.rst | 0 .../MEMCACHED_UNKNOWN_READ_FAILURE.rst | 0 .../MEMCACHED_UNKNOWN_STAT_KEY.rst | 0 .../client_errors/MEMCACHED_VALUE.rst | 0 .../client_errors/MEMCACHED_WRITE_FAILURE.rst | 0 docs/{ => source}/conf.py.in | 0 docs/{ => source}/error_messages.rst | 0 docs/{ => source}/hashkit_create.rst | 0 docs/{ => source}/hashkit_functions.rst | 0 docs/{ => source}/hashkit_value.rst | 0 docs/{ => source}/index.rst | 0 docs/{ => source}/libhashkit.rst | 0 docs/{ => source}/libmemcached-1.0/index.rst | 0 .../memcached_set_encoding_key.rst | 0 .../libmemcached-1.0/memcached_touch.rst | 0 docs/{ => source}/libmemcached-1.1/index.rst | 0 docs/{ => source}/libmemcached.rst | 0 docs/{ => source}/libmemcached/defaults.rst | 0 .../libmemcached/memcached_exist.rst | 0 .../libmemcached/memcached_fetch.rst | 0 .../memcached_last_error_message.rst | 0 .../libmemcached/memcached_return_t.rst | 0 .../libmemcached_configuration.rst | 0 docs/{ => source}/libmemcached_examples.rst | 0 docs/{ => source}/libmemcachedutil.rst | 0 docs/{ => source}/memcached_analyze.rst | 0 docs/{ => source}/memcached_append.rst | 0 docs/{ => source}/memcached_auto.rst | 0 docs/{ => source}/memcached_behavior.rst | 0 docs/{ => source}/memcached_callback.rst | 0 docs/{ => source}/memcached_cas.rst | 0 docs/{ => source}/memcached_create.rst | 0 docs/{ => source}/memcached_delete.rst | 0 docs/{ => source}/memcached_dump.rst | 0 docs/{ => source}/memcached_flush.rst | 0 docs/{ => source}/memcached_flush_buffers.rst | 0 .../memcached_generate_hash_value.rst | 0 docs/{ => source}/memcached_get.rst | 0 .../memcached_memory_allocators.rst | 0 docs/{ => source}/memcached_pool.rst | 0 docs/{ => source}/memcached_quit.rst | 0 docs/{ => source}/memcached_result_st.rst | 0 docs/{ => source}/memcached_sasl.rst | 0 docs/{ => source}/memcached_server_st.rst | 0 docs/{ => source}/memcached_servers.rst | 0 docs/{ => source}/memcached_set.rst | 0 docs/{ => source}/memcached_stats.rst | 0 docs/{ => source}/memcached_strerror.rst | 0 docs/{ => source}/memcached_user_data.rst | 0 docs/{ => source}/memcached_verbosity.rst | 0 docs/{ => source}/memcached_version.rst | 0 docs/{ => source}/tap.rst | 0 docs/{ => source}/types.rst | 0 docs/{ => source}/versioning.rst | 0 man/include.am | 8 +- 115 files changed, 212 insertions(+), 112 deletions(-) create mode 100644 docs/Makefile delete mode 100644 docs/include.am rename docs/{ => source}/bin/memaslap.rst (100%) rename docs/{ => source}/bin/memcapable.rst (100%) rename docs/{ => source}/bin/memcat.rst (100%) rename docs/{ => source}/bin/memcp.rst (100%) rename docs/{ => source}/bin/memdump.rst (100%) rename docs/{ => source}/bin/memerror.rst (100%) rename docs/{ => source}/bin/memexist.rst (100%) rename docs/{ => source}/bin/memflush.rst (100%) rename docs/{ => source}/bin/memparse.rst (100%) rename docs/{ => source}/bin/memping.rst (100%) rename docs/{ => source}/bin/memrm.rst (100%) rename docs/{ => source}/bin/memslap.rst (100%) rename docs/{ => source}/bin/memstat.rst (100%) rename docs/{ => source}/bin/memtouch.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_AUTH_CONTINUE.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_AUTH_FAILURE.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_AUTH_PROBLEM.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_BAD_KEY_PROVIDED.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_BUFFERED.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_CLIENT_ERROR.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_CONNECTION_BIND_FAILURE.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_CONNECTION_FAILURE.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_DATA_DOES_NOT_EXIST.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_DATA_EXISTS.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_DELETED.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_DEPRECATED.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_E2BIG.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_END.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_ERRNO.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_FAILURE.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_FAIL_UNIX_SOCKET.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_FETCH_NOTFINISHED.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_HOST_LOOKUP_FAILURE.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_INVALID_ARGUMENTS.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_INVALID_HOST_PROTOCOL.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_ITEM.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_KEY_TOO_BIG.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_MAXIMUM_RETURN.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_MEMORY_ALLOCATION_FAILURE.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_NOTFOUND.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_NOTSTORED.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_NOT_SUPPORTED.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_NO_KEY_PROVIDED.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_NO_SERVERS.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_PARSE_ERROR.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_PARSE_USER_ERROR.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_PARTIAL_READ.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_PROTOCOL_ERROR.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_READ_FAILURE.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_SERVER_ERROR.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_SERVER_MARKED_DEAD.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_SOME_ERRORS.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_STAT.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_STORED.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_SUCCESS.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_TIMEOUT.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_UNKNOWN_READ_FAILURE.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_UNKNOWN_STAT_KEY.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_VALUE.rst (100%) rename docs/{ => source}/client_errors/MEMCACHED_WRITE_FAILURE.rst (100%) rename docs/{ => source}/conf.py.in (100%) rename docs/{ => source}/error_messages.rst (100%) rename docs/{ => source}/hashkit_create.rst (100%) rename docs/{ => source}/hashkit_functions.rst (100%) rename docs/{ => source}/hashkit_value.rst (100%) rename docs/{ => source}/index.rst (100%) rename docs/{ => source}/libhashkit.rst (100%) rename docs/{ => source}/libmemcached-1.0/index.rst (100%) rename docs/{ => source}/libmemcached-1.0/memcached_set_encoding_key.rst (100%) rename docs/{ => source}/libmemcached-1.0/memcached_touch.rst (100%) rename docs/{ => source}/libmemcached-1.1/index.rst (100%) rename docs/{ => source}/libmemcached.rst (100%) rename docs/{ => source}/libmemcached/defaults.rst (100%) rename docs/{ => source}/libmemcached/memcached_exist.rst (100%) rename docs/{ => source}/libmemcached/memcached_fetch.rst (100%) rename docs/{ => source}/libmemcached/memcached_last_error_message.rst (100%) rename docs/{ => source}/libmemcached/memcached_return_t.rst (100%) rename docs/{ => source}/libmemcached_configuration.rst (100%) rename docs/{ => source}/libmemcached_examples.rst (100%) rename docs/{ => source}/libmemcachedutil.rst (100%) rename docs/{ => source}/memcached_analyze.rst (100%) rename docs/{ => source}/memcached_append.rst (100%) rename docs/{ => source}/memcached_auto.rst (100%) rename docs/{ => source}/memcached_behavior.rst (100%) rename docs/{ => source}/memcached_callback.rst (100%) rename docs/{ => source}/memcached_cas.rst (100%) rename docs/{ => source}/memcached_create.rst (100%) rename docs/{ => source}/memcached_delete.rst (100%) rename docs/{ => source}/memcached_dump.rst (100%) rename docs/{ => source}/memcached_flush.rst (100%) rename docs/{ => source}/memcached_flush_buffers.rst (100%) rename docs/{ => source}/memcached_generate_hash_value.rst (100%) rename docs/{ => source}/memcached_get.rst (100%) rename docs/{ => source}/memcached_memory_allocators.rst (100%) rename docs/{ => source}/memcached_pool.rst (100%) rename docs/{ => source}/memcached_quit.rst (100%) rename docs/{ => source}/memcached_result_st.rst (100%) rename docs/{ => source}/memcached_sasl.rst (100%) rename docs/{ => source}/memcached_server_st.rst (100%) rename docs/{ => source}/memcached_servers.rst (100%) rename docs/{ => source}/memcached_set.rst (100%) rename docs/{ => source}/memcached_stats.rst (100%) rename docs/{ => source}/memcached_strerror.rst (100%) rename docs/{ => source}/memcached_user_data.rst (100%) rename docs/{ => source}/memcached_verbosity.rst (100%) rename docs/{ => source}/memcached_version.rst (100%) rename docs/{ => source}/tap.rst (100%) rename docs/{ => source}/types.rst (100%) rename docs/{ => source}/versioning.rst (100%) diff --git a/Makefile.am b/Makefile.am index 895debbc..e8a4121c 100644 --- a/Makefile.am +++ b/Makefile.am @@ -26,6 +26,10 @@ EXTRA_DIST= dist_man_MANS= MAINTAINERCLEANFILES= +if IS_VCS_CHECKOUT +SUBDIRS= docs +endif + #includes additional rules from aminclude.am @INC_AMINCLUDE@ @@ -57,7 +61,7 @@ endif include libmemcachedutil-1.0/include.am include clients/include.am -include docs/include.am + include man/include.am if BUILD_LIBMEMCACHED_PROTOCOL @@ -103,7 +107,7 @@ merge-clean: @echo "Files that need to be either removed or checked in:" @bzr unknowns -clean-local: clean-libtest-check clean-docs-check clean-rpm +clean-local: clean-libtest-check clean-rpm lcov: lcov-clean check @@ -125,10 +129,7 @@ DISTCLEANFILES+= config/top.h maintainer-clean-local: find . -type f -name '*~' -exec rm -f '{}' \; - -rm -f man/*.1 - -rm -f man/*.3 - -rm -f man/*.8 - -rm -rf man/.doctrees/ + -$(RM) $(dist_man_MANS) -rm -f Makefile.in -rm -f aclocal.m4 -rm -f build-aux/compile diff --git a/configure.ac b/configure.ac index 17b7351e..b493172b 100644 --- a/configure.ac +++ b/configure.ac @@ -335,7 +335,7 @@ AX_HARDEN_COMPILER_FLAGS AX_AM_JOBSERVER([yes]) AC_CONFIG_FILES([Makefile - docs/conf.py + docs/source/conf.py libmemcached-1.0/configure.h support/libmemcached.pc support/libmemcached.spec diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..9ce1fa72 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,200 @@ +# Makefile for Sphinx documentation + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = build + +# Custom rules used by top level make +MANGOAL:= $(BUILDDIR)/man/.dirstamp +HTMLGOAL:= $(BUILDDIR)/html/.dirstamp + +.PHONY: all distclean distcheck maintainer-clean check test +all: $(MANGOAL) $(HTMLGOAL) + +maintainer-clean distclean: clean + +distcheck check distdir: + +RST_FILES= $(shell find source -type f -name '*.rst') + +.DEFAULT_GOAL:= all + +.NOTPARALLEL: + +SOURCES= +SOURCES+= $(RST_FILES) +SOURCES+= source/conf.py +SOURCES+= Makefile + +$(MANGOAL): $(SOURCES) + @$(MAKE) $(AM_MAKEFLAGS) man + @touch $@ + +$(HTMLGOAL): $(SOURCES) + @$(MAKE) $(AM_MAKEFLAGS) html + @touch $@ + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source + +.PHONY: help clean dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + @$(RM) -r $(BUILDDIR)/* + +html: $(SOURCES) + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/gearmand.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/gearmand.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/gearmand" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/gearmand" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: $(SOURCES) + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + @$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/include.am b/docs/include.am deleted file mode 100644 index f28079f8..00000000 --- a/docs/include.am +++ /dev/null @@ -1,101 +0,0 @@ -# vim:ft=automake -# included from Top Level Makefile.am -# All paths should be given relative to the root - -# Makefile for Sphinx documentation -# - -SPHINXOPTS = ${SPHINX_WARNINGS} -q -PAPER = -SPHINX_BUILDDIR = ${abs_top_builddir}/docs - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SPHINX_BUILDDIR) - -.PHONY: clean-docs-check -clean-docs-check: - -rm -rf docs/_build docs/doctrees man/.doctrees/ - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest - -sphinx-help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -install-html-local: html-local - @$(MKDIR_P) $(htmldir)/html - @cp -r ${top_builddir}/html $(htmldir)/ - -html-local: docs/conf.py - @PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) ${top_builddir}/html - -singlehtml: html-local - @PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/singlehtml - -pickle: docs/conf.py - PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: docs/conf.py - PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: docs/conf.py - 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." - -epub: docs/conf.py - PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(SPHINX_BUILDDIR)/epub." - -latex: docs/conf.py - 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 - 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: docs/conf.py - @PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/text - -man: - @PYTHONPATH=$(SPHINX_BUILDDIR)/docs $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) ${top_builddir}/man - - -changes: docs/conf.py - @PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/changes - -linkcheck: docs/conf.py - PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/linkcheck - -doctest: docs/conf.py - 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." diff --git a/docs/bin/memaslap.rst b/docs/source/bin/memaslap.rst similarity index 100% rename from docs/bin/memaslap.rst rename to docs/source/bin/memaslap.rst diff --git a/docs/bin/memcapable.rst b/docs/source/bin/memcapable.rst similarity index 100% rename from docs/bin/memcapable.rst rename to docs/source/bin/memcapable.rst diff --git a/docs/bin/memcat.rst b/docs/source/bin/memcat.rst similarity index 100% rename from docs/bin/memcat.rst rename to docs/source/bin/memcat.rst diff --git a/docs/bin/memcp.rst b/docs/source/bin/memcp.rst similarity index 100% rename from docs/bin/memcp.rst rename to docs/source/bin/memcp.rst diff --git a/docs/bin/memdump.rst b/docs/source/bin/memdump.rst similarity index 100% rename from docs/bin/memdump.rst rename to docs/source/bin/memdump.rst diff --git a/docs/bin/memerror.rst b/docs/source/bin/memerror.rst similarity index 100% rename from docs/bin/memerror.rst rename to docs/source/bin/memerror.rst diff --git a/docs/bin/memexist.rst b/docs/source/bin/memexist.rst similarity index 100% rename from docs/bin/memexist.rst rename to docs/source/bin/memexist.rst diff --git a/docs/bin/memflush.rst b/docs/source/bin/memflush.rst similarity index 100% rename from docs/bin/memflush.rst rename to docs/source/bin/memflush.rst diff --git a/docs/bin/memparse.rst b/docs/source/bin/memparse.rst similarity index 100% rename from docs/bin/memparse.rst rename to docs/source/bin/memparse.rst diff --git a/docs/bin/memping.rst b/docs/source/bin/memping.rst similarity index 100% rename from docs/bin/memping.rst rename to docs/source/bin/memping.rst diff --git a/docs/bin/memrm.rst b/docs/source/bin/memrm.rst similarity index 100% rename from docs/bin/memrm.rst rename to docs/source/bin/memrm.rst diff --git a/docs/bin/memslap.rst b/docs/source/bin/memslap.rst similarity index 100% rename from docs/bin/memslap.rst rename to docs/source/bin/memslap.rst diff --git a/docs/bin/memstat.rst b/docs/source/bin/memstat.rst similarity index 100% rename from docs/bin/memstat.rst rename to docs/source/bin/memstat.rst diff --git a/docs/bin/memtouch.rst b/docs/source/bin/memtouch.rst similarity index 100% rename from docs/bin/memtouch.rst rename to docs/source/bin/memtouch.rst diff --git a/docs/client_errors/MEMCACHED_AUTH_CONTINUE.rst b/docs/source/client_errors/MEMCACHED_AUTH_CONTINUE.rst similarity index 100% rename from docs/client_errors/MEMCACHED_AUTH_CONTINUE.rst rename to docs/source/client_errors/MEMCACHED_AUTH_CONTINUE.rst diff --git a/docs/client_errors/MEMCACHED_AUTH_FAILURE.rst b/docs/source/client_errors/MEMCACHED_AUTH_FAILURE.rst similarity index 100% rename from docs/client_errors/MEMCACHED_AUTH_FAILURE.rst rename to docs/source/client_errors/MEMCACHED_AUTH_FAILURE.rst diff --git a/docs/client_errors/MEMCACHED_AUTH_PROBLEM.rst b/docs/source/client_errors/MEMCACHED_AUTH_PROBLEM.rst similarity index 100% rename from docs/client_errors/MEMCACHED_AUTH_PROBLEM.rst rename to docs/source/client_errors/MEMCACHED_AUTH_PROBLEM.rst diff --git a/docs/client_errors/MEMCACHED_BAD_KEY_PROVIDED.rst b/docs/source/client_errors/MEMCACHED_BAD_KEY_PROVIDED.rst similarity index 100% rename from docs/client_errors/MEMCACHED_BAD_KEY_PROVIDED.rst rename to docs/source/client_errors/MEMCACHED_BAD_KEY_PROVIDED.rst diff --git a/docs/client_errors/MEMCACHED_BUFFERED.rst b/docs/source/client_errors/MEMCACHED_BUFFERED.rst similarity index 100% rename from docs/client_errors/MEMCACHED_BUFFERED.rst rename to docs/source/client_errors/MEMCACHED_BUFFERED.rst diff --git a/docs/client_errors/MEMCACHED_CLIENT_ERROR.rst b/docs/source/client_errors/MEMCACHED_CLIENT_ERROR.rst similarity index 100% rename from docs/client_errors/MEMCACHED_CLIENT_ERROR.rst rename to docs/source/client_errors/MEMCACHED_CLIENT_ERROR.rst diff --git a/docs/client_errors/MEMCACHED_CONNECTION_BIND_FAILURE.rst b/docs/source/client_errors/MEMCACHED_CONNECTION_BIND_FAILURE.rst similarity index 100% rename from docs/client_errors/MEMCACHED_CONNECTION_BIND_FAILURE.rst rename to docs/source/client_errors/MEMCACHED_CONNECTION_BIND_FAILURE.rst diff --git a/docs/client_errors/MEMCACHED_CONNECTION_FAILURE.rst b/docs/source/client_errors/MEMCACHED_CONNECTION_FAILURE.rst similarity index 100% rename from docs/client_errors/MEMCACHED_CONNECTION_FAILURE.rst rename to docs/source/client_errors/MEMCACHED_CONNECTION_FAILURE.rst diff --git a/docs/client_errors/MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE.rst b/docs/source/client_errors/MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE.rst similarity index 100% rename from docs/client_errors/MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE.rst rename to docs/source/client_errors/MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE.rst diff --git a/docs/client_errors/MEMCACHED_DATA_DOES_NOT_EXIST.rst b/docs/source/client_errors/MEMCACHED_DATA_DOES_NOT_EXIST.rst similarity index 100% rename from docs/client_errors/MEMCACHED_DATA_DOES_NOT_EXIST.rst rename to docs/source/client_errors/MEMCACHED_DATA_DOES_NOT_EXIST.rst diff --git a/docs/client_errors/MEMCACHED_DATA_EXISTS.rst b/docs/source/client_errors/MEMCACHED_DATA_EXISTS.rst similarity index 100% rename from docs/client_errors/MEMCACHED_DATA_EXISTS.rst rename to docs/source/client_errors/MEMCACHED_DATA_EXISTS.rst diff --git a/docs/client_errors/MEMCACHED_DELETED.rst b/docs/source/client_errors/MEMCACHED_DELETED.rst similarity index 100% rename from docs/client_errors/MEMCACHED_DELETED.rst rename to docs/source/client_errors/MEMCACHED_DELETED.rst diff --git a/docs/client_errors/MEMCACHED_DEPRECATED.rst b/docs/source/client_errors/MEMCACHED_DEPRECATED.rst similarity index 100% rename from docs/client_errors/MEMCACHED_DEPRECATED.rst rename to docs/source/client_errors/MEMCACHED_DEPRECATED.rst diff --git a/docs/client_errors/MEMCACHED_E2BIG.rst b/docs/source/client_errors/MEMCACHED_E2BIG.rst similarity index 100% rename from docs/client_errors/MEMCACHED_E2BIG.rst rename to docs/source/client_errors/MEMCACHED_E2BIG.rst diff --git a/docs/client_errors/MEMCACHED_END.rst b/docs/source/client_errors/MEMCACHED_END.rst similarity index 100% rename from docs/client_errors/MEMCACHED_END.rst rename to docs/source/client_errors/MEMCACHED_END.rst diff --git a/docs/client_errors/MEMCACHED_ERRNO.rst b/docs/source/client_errors/MEMCACHED_ERRNO.rst similarity index 100% rename from docs/client_errors/MEMCACHED_ERRNO.rst rename to docs/source/client_errors/MEMCACHED_ERRNO.rst diff --git a/docs/client_errors/MEMCACHED_FAILURE.rst b/docs/source/client_errors/MEMCACHED_FAILURE.rst similarity index 100% rename from docs/client_errors/MEMCACHED_FAILURE.rst rename to docs/source/client_errors/MEMCACHED_FAILURE.rst diff --git a/docs/client_errors/MEMCACHED_FAIL_UNIX_SOCKET.rst b/docs/source/client_errors/MEMCACHED_FAIL_UNIX_SOCKET.rst similarity index 100% rename from docs/client_errors/MEMCACHED_FAIL_UNIX_SOCKET.rst rename to docs/source/client_errors/MEMCACHED_FAIL_UNIX_SOCKET.rst diff --git a/docs/client_errors/MEMCACHED_FETCH_NOTFINISHED.rst b/docs/source/client_errors/MEMCACHED_FETCH_NOTFINISHED.rst similarity index 100% rename from docs/client_errors/MEMCACHED_FETCH_NOTFINISHED.rst rename to docs/source/client_errors/MEMCACHED_FETCH_NOTFINISHED.rst diff --git a/docs/client_errors/MEMCACHED_HOST_LOOKUP_FAILURE.rst b/docs/source/client_errors/MEMCACHED_HOST_LOOKUP_FAILURE.rst similarity index 100% rename from docs/client_errors/MEMCACHED_HOST_LOOKUP_FAILURE.rst rename to docs/source/client_errors/MEMCACHED_HOST_LOOKUP_FAILURE.rst diff --git a/docs/client_errors/MEMCACHED_INVALID_ARGUMENTS.rst b/docs/source/client_errors/MEMCACHED_INVALID_ARGUMENTS.rst similarity index 100% rename from docs/client_errors/MEMCACHED_INVALID_ARGUMENTS.rst rename to docs/source/client_errors/MEMCACHED_INVALID_ARGUMENTS.rst diff --git a/docs/client_errors/MEMCACHED_INVALID_HOST_PROTOCOL.rst b/docs/source/client_errors/MEMCACHED_INVALID_HOST_PROTOCOL.rst similarity index 100% rename from docs/client_errors/MEMCACHED_INVALID_HOST_PROTOCOL.rst rename to docs/source/client_errors/MEMCACHED_INVALID_HOST_PROTOCOL.rst diff --git a/docs/client_errors/MEMCACHED_ITEM.rst b/docs/source/client_errors/MEMCACHED_ITEM.rst similarity index 100% rename from docs/client_errors/MEMCACHED_ITEM.rst rename to docs/source/client_errors/MEMCACHED_ITEM.rst diff --git a/docs/client_errors/MEMCACHED_KEY_TOO_BIG.rst b/docs/source/client_errors/MEMCACHED_KEY_TOO_BIG.rst similarity index 100% rename from docs/client_errors/MEMCACHED_KEY_TOO_BIG.rst rename to docs/source/client_errors/MEMCACHED_KEY_TOO_BIG.rst diff --git a/docs/client_errors/MEMCACHED_MAXIMUM_RETURN.rst b/docs/source/client_errors/MEMCACHED_MAXIMUM_RETURN.rst similarity index 100% rename from docs/client_errors/MEMCACHED_MAXIMUM_RETURN.rst rename to docs/source/client_errors/MEMCACHED_MAXIMUM_RETURN.rst diff --git a/docs/client_errors/MEMCACHED_MEMORY_ALLOCATION_FAILURE.rst b/docs/source/client_errors/MEMCACHED_MEMORY_ALLOCATION_FAILURE.rst similarity index 100% rename from docs/client_errors/MEMCACHED_MEMORY_ALLOCATION_FAILURE.rst rename to docs/source/client_errors/MEMCACHED_MEMORY_ALLOCATION_FAILURE.rst diff --git a/docs/client_errors/MEMCACHED_NOTFOUND.rst b/docs/source/client_errors/MEMCACHED_NOTFOUND.rst similarity index 100% rename from docs/client_errors/MEMCACHED_NOTFOUND.rst rename to docs/source/client_errors/MEMCACHED_NOTFOUND.rst diff --git a/docs/client_errors/MEMCACHED_NOTSTORED.rst b/docs/source/client_errors/MEMCACHED_NOTSTORED.rst similarity index 100% rename from docs/client_errors/MEMCACHED_NOTSTORED.rst rename to docs/source/client_errors/MEMCACHED_NOTSTORED.rst diff --git a/docs/client_errors/MEMCACHED_NOT_SUPPORTED.rst b/docs/source/client_errors/MEMCACHED_NOT_SUPPORTED.rst similarity index 100% rename from docs/client_errors/MEMCACHED_NOT_SUPPORTED.rst rename to docs/source/client_errors/MEMCACHED_NOT_SUPPORTED.rst diff --git a/docs/client_errors/MEMCACHED_NO_KEY_PROVIDED.rst b/docs/source/client_errors/MEMCACHED_NO_KEY_PROVIDED.rst similarity index 100% rename from docs/client_errors/MEMCACHED_NO_KEY_PROVIDED.rst rename to docs/source/client_errors/MEMCACHED_NO_KEY_PROVIDED.rst diff --git a/docs/client_errors/MEMCACHED_NO_SERVERS.rst b/docs/source/client_errors/MEMCACHED_NO_SERVERS.rst similarity index 100% rename from docs/client_errors/MEMCACHED_NO_SERVERS.rst rename to docs/source/client_errors/MEMCACHED_NO_SERVERS.rst diff --git a/docs/client_errors/MEMCACHED_PARSE_ERROR.rst b/docs/source/client_errors/MEMCACHED_PARSE_ERROR.rst similarity index 100% rename from docs/client_errors/MEMCACHED_PARSE_ERROR.rst rename to docs/source/client_errors/MEMCACHED_PARSE_ERROR.rst diff --git a/docs/client_errors/MEMCACHED_PARSE_USER_ERROR.rst b/docs/source/client_errors/MEMCACHED_PARSE_USER_ERROR.rst similarity index 100% rename from docs/client_errors/MEMCACHED_PARSE_USER_ERROR.rst rename to docs/source/client_errors/MEMCACHED_PARSE_USER_ERROR.rst diff --git a/docs/client_errors/MEMCACHED_PARTIAL_READ.rst b/docs/source/client_errors/MEMCACHED_PARTIAL_READ.rst similarity index 100% rename from docs/client_errors/MEMCACHED_PARTIAL_READ.rst rename to docs/source/client_errors/MEMCACHED_PARTIAL_READ.rst diff --git a/docs/client_errors/MEMCACHED_PROTOCOL_ERROR.rst b/docs/source/client_errors/MEMCACHED_PROTOCOL_ERROR.rst similarity index 100% rename from docs/client_errors/MEMCACHED_PROTOCOL_ERROR.rst rename to docs/source/client_errors/MEMCACHED_PROTOCOL_ERROR.rst diff --git a/docs/client_errors/MEMCACHED_READ_FAILURE.rst b/docs/source/client_errors/MEMCACHED_READ_FAILURE.rst similarity index 100% rename from docs/client_errors/MEMCACHED_READ_FAILURE.rst rename to docs/source/client_errors/MEMCACHED_READ_FAILURE.rst diff --git a/docs/client_errors/MEMCACHED_SERVER_ERROR.rst b/docs/source/client_errors/MEMCACHED_SERVER_ERROR.rst similarity index 100% rename from docs/client_errors/MEMCACHED_SERVER_ERROR.rst rename to docs/source/client_errors/MEMCACHED_SERVER_ERROR.rst diff --git a/docs/client_errors/MEMCACHED_SERVER_MARKED_DEAD.rst b/docs/source/client_errors/MEMCACHED_SERVER_MARKED_DEAD.rst similarity index 100% rename from docs/client_errors/MEMCACHED_SERVER_MARKED_DEAD.rst rename to docs/source/client_errors/MEMCACHED_SERVER_MARKED_DEAD.rst diff --git a/docs/client_errors/MEMCACHED_SOME_ERRORS.rst b/docs/source/client_errors/MEMCACHED_SOME_ERRORS.rst similarity index 100% rename from docs/client_errors/MEMCACHED_SOME_ERRORS.rst rename to docs/source/client_errors/MEMCACHED_SOME_ERRORS.rst diff --git a/docs/client_errors/MEMCACHED_STAT.rst b/docs/source/client_errors/MEMCACHED_STAT.rst similarity index 100% rename from docs/client_errors/MEMCACHED_STAT.rst rename to docs/source/client_errors/MEMCACHED_STAT.rst diff --git a/docs/client_errors/MEMCACHED_STORED.rst b/docs/source/client_errors/MEMCACHED_STORED.rst similarity index 100% rename from docs/client_errors/MEMCACHED_STORED.rst rename to docs/source/client_errors/MEMCACHED_STORED.rst diff --git a/docs/client_errors/MEMCACHED_SUCCESS.rst b/docs/source/client_errors/MEMCACHED_SUCCESS.rst similarity index 100% rename from docs/client_errors/MEMCACHED_SUCCESS.rst rename to docs/source/client_errors/MEMCACHED_SUCCESS.rst diff --git a/docs/client_errors/MEMCACHED_TIMEOUT.rst b/docs/source/client_errors/MEMCACHED_TIMEOUT.rst similarity index 100% rename from docs/client_errors/MEMCACHED_TIMEOUT.rst rename to docs/source/client_errors/MEMCACHED_TIMEOUT.rst diff --git a/docs/client_errors/MEMCACHED_UNKNOWN_READ_FAILURE.rst b/docs/source/client_errors/MEMCACHED_UNKNOWN_READ_FAILURE.rst similarity index 100% rename from docs/client_errors/MEMCACHED_UNKNOWN_READ_FAILURE.rst rename to docs/source/client_errors/MEMCACHED_UNKNOWN_READ_FAILURE.rst diff --git a/docs/client_errors/MEMCACHED_UNKNOWN_STAT_KEY.rst b/docs/source/client_errors/MEMCACHED_UNKNOWN_STAT_KEY.rst similarity index 100% rename from docs/client_errors/MEMCACHED_UNKNOWN_STAT_KEY.rst rename to docs/source/client_errors/MEMCACHED_UNKNOWN_STAT_KEY.rst diff --git a/docs/client_errors/MEMCACHED_VALUE.rst b/docs/source/client_errors/MEMCACHED_VALUE.rst similarity index 100% rename from docs/client_errors/MEMCACHED_VALUE.rst rename to docs/source/client_errors/MEMCACHED_VALUE.rst diff --git a/docs/client_errors/MEMCACHED_WRITE_FAILURE.rst b/docs/source/client_errors/MEMCACHED_WRITE_FAILURE.rst similarity index 100% rename from docs/client_errors/MEMCACHED_WRITE_FAILURE.rst rename to docs/source/client_errors/MEMCACHED_WRITE_FAILURE.rst diff --git a/docs/conf.py.in b/docs/source/conf.py.in similarity index 100% rename from docs/conf.py.in rename to docs/source/conf.py.in diff --git a/docs/error_messages.rst b/docs/source/error_messages.rst similarity index 100% rename from docs/error_messages.rst rename to docs/source/error_messages.rst diff --git a/docs/hashkit_create.rst b/docs/source/hashkit_create.rst similarity index 100% rename from docs/hashkit_create.rst rename to docs/source/hashkit_create.rst diff --git a/docs/hashkit_functions.rst b/docs/source/hashkit_functions.rst similarity index 100% rename from docs/hashkit_functions.rst rename to docs/source/hashkit_functions.rst diff --git a/docs/hashkit_value.rst b/docs/source/hashkit_value.rst similarity index 100% rename from docs/hashkit_value.rst rename to docs/source/hashkit_value.rst diff --git a/docs/index.rst b/docs/source/index.rst similarity index 100% rename from docs/index.rst rename to docs/source/index.rst diff --git a/docs/libhashkit.rst b/docs/source/libhashkit.rst similarity index 100% rename from docs/libhashkit.rst rename to docs/source/libhashkit.rst diff --git a/docs/libmemcached-1.0/index.rst b/docs/source/libmemcached-1.0/index.rst similarity index 100% rename from docs/libmemcached-1.0/index.rst rename to docs/source/libmemcached-1.0/index.rst diff --git a/docs/libmemcached-1.0/memcached_set_encoding_key.rst b/docs/source/libmemcached-1.0/memcached_set_encoding_key.rst similarity index 100% rename from docs/libmemcached-1.0/memcached_set_encoding_key.rst rename to docs/source/libmemcached-1.0/memcached_set_encoding_key.rst diff --git a/docs/libmemcached-1.0/memcached_touch.rst b/docs/source/libmemcached-1.0/memcached_touch.rst similarity index 100% rename from docs/libmemcached-1.0/memcached_touch.rst rename to docs/source/libmemcached-1.0/memcached_touch.rst diff --git a/docs/libmemcached-1.1/index.rst b/docs/source/libmemcached-1.1/index.rst similarity index 100% rename from docs/libmemcached-1.1/index.rst rename to docs/source/libmemcached-1.1/index.rst diff --git a/docs/libmemcached.rst b/docs/source/libmemcached.rst similarity index 100% rename from docs/libmemcached.rst rename to docs/source/libmemcached.rst diff --git a/docs/libmemcached/defaults.rst b/docs/source/libmemcached/defaults.rst similarity index 100% rename from docs/libmemcached/defaults.rst rename to docs/source/libmemcached/defaults.rst diff --git a/docs/libmemcached/memcached_exist.rst b/docs/source/libmemcached/memcached_exist.rst similarity index 100% rename from docs/libmemcached/memcached_exist.rst rename to docs/source/libmemcached/memcached_exist.rst diff --git a/docs/libmemcached/memcached_fetch.rst b/docs/source/libmemcached/memcached_fetch.rst similarity index 100% rename from docs/libmemcached/memcached_fetch.rst rename to docs/source/libmemcached/memcached_fetch.rst diff --git a/docs/libmemcached/memcached_last_error_message.rst b/docs/source/libmemcached/memcached_last_error_message.rst similarity index 100% rename from docs/libmemcached/memcached_last_error_message.rst rename to docs/source/libmemcached/memcached_last_error_message.rst diff --git a/docs/libmemcached/memcached_return_t.rst b/docs/source/libmemcached/memcached_return_t.rst similarity index 100% rename from docs/libmemcached/memcached_return_t.rst rename to docs/source/libmemcached/memcached_return_t.rst diff --git a/docs/libmemcached_configuration.rst b/docs/source/libmemcached_configuration.rst similarity index 100% rename from docs/libmemcached_configuration.rst rename to docs/source/libmemcached_configuration.rst diff --git a/docs/libmemcached_examples.rst b/docs/source/libmemcached_examples.rst similarity index 100% rename from docs/libmemcached_examples.rst rename to docs/source/libmemcached_examples.rst diff --git a/docs/libmemcachedutil.rst b/docs/source/libmemcachedutil.rst similarity index 100% rename from docs/libmemcachedutil.rst rename to docs/source/libmemcachedutil.rst diff --git a/docs/memcached_analyze.rst b/docs/source/memcached_analyze.rst similarity index 100% rename from docs/memcached_analyze.rst rename to docs/source/memcached_analyze.rst diff --git a/docs/memcached_append.rst b/docs/source/memcached_append.rst similarity index 100% rename from docs/memcached_append.rst rename to docs/source/memcached_append.rst diff --git a/docs/memcached_auto.rst b/docs/source/memcached_auto.rst similarity index 100% rename from docs/memcached_auto.rst rename to docs/source/memcached_auto.rst diff --git a/docs/memcached_behavior.rst b/docs/source/memcached_behavior.rst similarity index 100% rename from docs/memcached_behavior.rst rename to docs/source/memcached_behavior.rst diff --git a/docs/memcached_callback.rst b/docs/source/memcached_callback.rst similarity index 100% rename from docs/memcached_callback.rst rename to docs/source/memcached_callback.rst diff --git a/docs/memcached_cas.rst b/docs/source/memcached_cas.rst similarity index 100% rename from docs/memcached_cas.rst rename to docs/source/memcached_cas.rst diff --git a/docs/memcached_create.rst b/docs/source/memcached_create.rst similarity index 100% rename from docs/memcached_create.rst rename to docs/source/memcached_create.rst diff --git a/docs/memcached_delete.rst b/docs/source/memcached_delete.rst similarity index 100% rename from docs/memcached_delete.rst rename to docs/source/memcached_delete.rst diff --git a/docs/memcached_dump.rst b/docs/source/memcached_dump.rst similarity index 100% rename from docs/memcached_dump.rst rename to docs/source/memcached_dump.rst diff --git a/docs/memcached_flush.rst b/docs/source/memcached_flush.rst similarity index 100% rename from docs/memcached_flush.rst rename to docs/source/memcached_flush.rst diff --git a/docs/memcached_flush_buffers.rst b/docs/source/memcached_flush_buffers.rst similarity index 100% rename from docs/memcached_flush_buffers.rst rename to docs/source/memcached_flush_buffers.rst diff --git a/docs/memcached_generate_hash_value.rst b/docs/source/memcached_generate_hash_value.rst similarity index 100% rename from docs/memcached_generate_hash_value.rst rename to docs/source/memcached_generate_hash_value.rst diff --git a/docs/memcached_get.rst b/docs/source/memcached_get.rst similarity index 100% rename from docs/memcached_get.rst rename to docs/source/memcached_get.rst diff --git a/docs/memcached_memory_allocators.rst b/docs/source/memcached_memory_allocators.rst similarity index 100% rename from docs/memcached_memory_allocators.rst rename to docs/source/memcached_memory_allocators.rst diff --git a/docs/memcached_pool.rst b/docs/source/memcached_pool.rst similarity index 100% rename from docs/memcached_pool.rst rename to docs/source/memcached_pool.rst diff --git a/docs/memcached_quit.rst b/docs/source/memcached_quit.rst similarity index 100% rename from docs/memcached_quit.rst rename to docs/source/memcached_quit.rst diff --git a/docs/memcached_result_st.rst b/docs/source/memcached_result_st.rst similarity index 100% rename from docs/memcached_result_st.rst rename to docs/source/memcached_result_st.rst diff --git a/docs/memcached_sasl.rst b/docs/source/memcached_sasl.rst similarity index 100% rename from docs/memcached_sasl.rst rename to docs/source/memcached_sasl.rst diff --git a/docs/memcached_server_st.rst b/docs/source/memcached_server_st.rst similarity index 100% rename from docs/memcached_server_st.rst rename to docs/source/memcached_server_st.rst diff --git a/docs/memcached_servers.rst b/docs/source/memcached_servers.rst similarity index 100% rename from docs/memcached_servers.rst rename to docs/source/memcached_servers.rst diff --git a/docs/memcached_set.rst b/docs/source/memcached_set.rst similarity index 100% rename from docs/memcached_set.rst rename to docs/source/memcached_set.rst diff --git a/docs/memcached_stats.rst b/docs/source/memcached_stats.rst similarity index 100% rename from docs/memcached_stats.rst rename to docs/source/memcached_stats.rst diff --git a/docs/memcached_strerror.rst b/docs/source/memcached_strerror.rst similarity index 100% rename from docs/memcached_strerror.rst rename to docs/source/memcached_strerror.rst diff --git a/docs/memcached_user_data.rst b/docs/source/memcached_user_data.rst similarity index 100% rename from docs/memcached_user_data.rst rename to docs/source/memcached_user_data.rst diff --git a/docs/memcached_verbosity.rst b/docs/source/memcached_verbosity.rst similarity index 100% rename from docs/memcached_verbosity.rst rename to docs/source/memcached_verbosity.rst diff --git a/docs/memcached_version.rst b/docs/source/memcached_version.rst similarity index 100% rename from docs/memcached_version.rst rename to docs/source/memcached_version.rst diff --git a/docs/tap.rst b/docs/source/tap.rst similarity index 100% rename from docs/tap.rst rename to docs/source/tap.rst diff --git a/docs/types.rst b/docs/source/types.rst similarity index 100% rename from docs/types.rst rename to docs/source/types.rst diff --git a/docs/versioning.rst b/docs/source/versioning.rst similarity index 100% rename from docs/versioning.rst rename to docs/source/versioning.rst diff --git a/man/include.am b/man/include.am index 602cfa96..c676fcaf 100644 --- a/man/include.am +++ b/man/include.am @@ -2,11 +2,11 @@ # included from Top Level Makefile.am # All paths should be given relative to the root -# Build rule for documentation -$(dist_man_MANS): $(top_srcdir)/configure.ac - $(MAKE) $(AM_MAKEFLAGS) man +RST_FILES= $(shell find $(top_builddir)/docs/source -type f -name '*.rst') -.NOTPARALLEL: $(dist_man_MANS) +# Build rule for documentation +$(dist_man_MANS): $(RST_FILES) + @cp docs/build/$@ $@ dist_man_MANS+= man/memaslap.1 dist_man_MANS+= man/memcapable.1 -- 2.30.2