X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finclude.am;h=f28079f8d6745b36a2912d482b977a703a47ef27;hb=dd1ce96a2171e9a2e13c08e56e22b03008e87367;hp=9538941151f83573b06e3abeb0a61f32a1434975;hpb=49fc1e5ea4ea006f4a2ac71428833760f6fac030;p=awesomized%2Flibmemcached

diff --git a/docs/include.am b/docs/include.am
index 95389411..f28079f8 100644
--- a/docs/include.am
+++ b/docs/include.am
@@ -2,157 +2,27 @@
 # included from Top Level Makefile.am
 # All paths should be given relative to the root
 
-EXTRA_DIST+= \
-	     docs/_static \
-	     docs/_templates \
-	     docs/conf.py \
-	     ${top_srcdir}/docs/*.rst
-
 # Makefile for Sphinx documentation
 #
 
-SPHINXOPTS    = ${SPHINX_WARNINGS} -D release=${PANDORA_RELEASE_VERSION}
+SPHINXOPTS    = ${SPHINX_WARNINGS} -q
 PAPER         =
-SPHINX_BUILDDIR      = ${top_builddir}/docs
+SPHINX_BUILDDIR      = ${abs_top_builddir}/docs
 
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d $(SPHINX_BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) ${top_srcdir}/docs
-
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
-
-if HAVE_RECENT_SPHINX
-
-man_MANS+= \
-           docs/man/hashkit_create.3 \
-	   docs/man/hashkit_functions.3 \
-	   docs/man/hashkit_value.3 \
-	   docs/man/libmemcached_examples.3 \
-	   docs/man/libmemcached.3 \
-	   docs/man/libmemcachedutil.3 \
-	   docs/man/memcached_analyze.3 \
-	   docs/man/memcached_auto.3 \
-	   docs/man/memcached_behavior.3 \
-	   docs/man/memcached_callback.3 \
-	   docs/man/memcached_create.3 \
-	   docs/man/memcached_delete.3 \
-	   docs/man/memcached_dump.3 \
-	   docs/man/memcached_flush_buffers.3 \
-	   docs/man/memcached_flush.3 \
-	   docs/man/memcached_generate_hash_value.3 \
-	   docs/man/memcached_get.3 \
-	   docs/man/memcached_memory_allocators.3 \
-	   docs/man/memcached_pool.3 \
-	   docs/man/memcached_quit.3 \
-	   docs/man/memcached_result_st.3 \
-	   docs/man/memcached_sasl.3 \
-	   docs/man/memcached_servers.3 \
-	   docs/man/memcached_server_st.3 \
-	   docs/man/memcached_set.3 \
-	   docs/man/memcached_stats.3 \
-	   docs/man/memcached_strerror.3 \
-	   docs/man/memcached_user_data.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
+ALLSPHINXOPTS   = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SPHINX_BUILDDIR)
 
-DISTCLEANFILES+= \
-                 docs/man/hashkit_create.3 \
-		 docs/man/hashkit_functions.3 \
-		 docs/man/hashkit_value.3 \
-		 docs/man/libmemcached_examples.3 \
-		 docs/man/libmemcached.3 \
-		 docs/man/libmemcachedutil.3 \
-		 docs/man/memcached_analyze.3 \
-		 docs/man/memcached_auto.3 \
-		 docs/man/memcached_behavior.3 \
-		 docs/man/memcached_callback.3 \
-		 docs/man/memcached_create.3 \
-	         docs/man/memcached_delete.3 \
-		 docs/man/memcached_dump.3 \
-		 docs/man/memcached_flush_buffers.3 \
-		 docs/man/memcached_flush.3 \
-		 docs/man/memcached_generate_hash_value.3 \
-		 docs/man/memcached_get.3 \
-		 docs/man/memcached_memory_allocators.3 \
-		 docs/man/memcached_pool.3 \
-		 docs/man/memcached_quit.3 \
-		 docs/man/memcached_result_st.3 \
-		 docs/man/memcached_sasl.3 \
-		 docs/man/memcached_servers.3 \
-		 docs/man/memcached_server_st.3 \
-		 docs/man/memcached_set.3 \
-		 docs/man/memcached_stats.3 \
-		 docs/man/memcached_strerror.3 \
-		 docs/man/memcached_user_data.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
+.PHONY: clean-docs-check
+clean-docs-check:
+	-rm -rf docs/_build docs/doctrees man/.doctrees/
 
-docs/man/hashkit_create.3: man
-docs/man/hashkit_functions.3: man
-docs/man/hashkit_value.3: man
-docs/man/libmemcached_examples.3: man
-docs/man/libmemcached.3: man
-docs/man/libmemcachedutil.3: man
-docs/man/memcached_analyze.3: man
-docs/man/memcached_auto.3: man
-docs/man/memcached_behavior.3: man
-docs/man/memcached_callback.3: man
-docs/man/memcached_create.3: man
-docs/man/memcached_delete.3: man
-docs/man/memcached_dump.3: man
-docs/man/memcached_flush_buffers.3: man
-docs/man/memcached_flush.3: man
-docs/man/memcached_generate_hash_value.3: man
-docs/man/memcached_get.3: man
-docs/man/memcached_memory_allocators.3: man
-docs/man/memcached_pool.3: man
-docs/man/memcached_quit.3: man
-docs/man/memcached_result_st.3: man
-docs/man/memcached_sasl.3: man
-docs/man/memcached_servers.3: man
-docs/man/memcached_server_st.3: man
-docs/man/memcached_set.3: man
-docs/man/memcached_stats.3: man
-docs/man/memcached_strerror.3: man
-docs/man/memcached_user_data.3: man
-docs/man/memcached_verbosity.3: man
-docs/man/memcached_version.3: man
-docs/man/memcapable.1: man
-docs/man/memcat.1: man
-docs/man/memcp.1: man
-docs/man/memdump.1: man
-docs/man/memerror.1: man
-docs/man/memflush.1: man
-docs/man/memrm.1: man
-docs/man/memslap.1: man
-docs/man/memstat.1: man
- 
-endif
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
 
-if HAVE_SPHINX
 sphinx-help:
 	@echo "Please use \`make <target>' where <target> 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"
@@ -168,61 +38,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:
-	PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/html
-	@echo
-	@echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/html."
+install-html-local: html-local
+	@$(MKDIR_P)  $(htmldir)/html
+	@cp -r ${top_builddir}/html $(htmldir)/
 
-dirhtml:
-	PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/dirhtml
-	@echo
-	@echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/dirhtml."
+html-local: docs/conf.py
+	@PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) ${top_builddir}/html
 
-singlehtml:
-	PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/singlehtml
-	@echo
-	@echo "Build finished. The HTML page is in $(SPHINX_BUILDDIR)/singlehtml."
+singlehtml: html-local
+	@PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/singlehtml
 
-pickle:
+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:
+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:
+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."
 
-qthelp:
-	PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/qthelp
-	@echo
-	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
-	      ".qhcp project file in $(SPHINX_BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(SPHINX_BUILDDIR)/qthelp/Drizzle.qhcp"
-	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(SPHINX_BUILDDIR)/qthelp/Drizzle.qhc"
-
-devhelp:
-	PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/devhelp
-	@echo
-	@echo "Build finished."
-	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/Drizzle"
-	@echo "# ln -s $(SPHINX_BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Drizzle"
-	@echo "# devhelp"
-
-epub:
+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:
+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."
@@ -235,29 +82,20 @@ latexpdf: latex
 	make -C $(SPHINX_BUILDDIR)/latex all-pdf
 	@echo "pdflatex finished; the PDF files are in $(SPHINX_BUILDDIR)/latex."
 
-text:
-	PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/text
-	@echo
-	@echo "Build finished. The text files are in $(SPHINX_BUILDDIR)/text."
+text: docs/conf.py
+	@PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/text
 
 man:
-	PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/man
-	@echo
-	@echo "Build finished. The manual pages are in $(SPHINX_BUILDDIR)/man."
+	@PYTHONPATH=$(SPHINX_BUILDDIR)/docs  $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) ${top_builddir}/man
 
-changes:
-	PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/changes
-	@echo
-	@echo "The overview file is in $(SPHINX_BUILDDIR)/changes."
 
-linkcheck:
+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
-	@echo
-	@echo "Link check complete; look for any errors in the above output " \
-	      "or in $(SPHINX_BUILDDIR)/linkcheck/output.txt."
 
-doctest:
+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."
-endif