gearman/docs/include.am

# vim:ft=automake
# included from Top Level Makefile.am
# All paths should be given relative to the root

EXTRA_DIST+= \
	     docs/conf.py \
	     docs/*.rst

# Makefile for Sphinx documentation
#

SPHINXOPTS    = ${SPHINX_WARNINGS} -D release=${PANDORA_RELEASE_VERSION}
PAPER         =
SPHINX_BUILDDIR      = ${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

man_MANS+= \
	   docs/man/gearadmin.1 \
	   docs/man/gearman.1 \
	   docs/man/gearman_bugreport.3 \
	   docs/man/gearman_client_add_options.3 \
	   docs/man/gearman_client_add_server.3 \
	   docs/man/gearman_client_add_servers.3 \
	   docs/man/gearman_client_add_task.3 \
	   docs/man/gearman_client_add_task_background.3 \
	   docs/man/gearman_client_add_task_high.3 \
	   docs/man/gearman_client_add_task_high_background.3 \
	   docs/man/gearman_client_add_task_low.3 \
	   docs/man/gearman_client_add_task_low_background.3 \
	   docs/man/gearman_client_add_task_status.3 \
	   docs/man/gearman_client_clear_fn.3 \
	   docs/man/gearman_client_clone.3 \
	   docs/man/gearman_client_context.3 \
	   docs/man/gearman_client_create.3 \
	   docs/man/gearman_client_do.3 \
	   docs/man/gearman_client_do_background.3 \
	   docs/man/gearman_client_do_high.3 \
	   docs/man/gearman_client_do_high_background.3 \
	   docs/man/gearman_client_do_job_handle.3 \
	   docs/man/gearman_client_do_low.3 \
	   docs/man/gearman_client_do_low_background.3 \
	   docs/man/gearman_client_do_status.3 \
	   docs/man/gearman_client_echo.3 \
	   docs/man/gearman_client_errno.3 \
	   docs/man/gearman_client_error.3 \
	   docs/man/gearman_client_free.3 \
	   docs/man/gearman_client_job_status.3 \
	   docs/man/gearman_client_options.3 \
	   docs/man/gearman_client_remove_options.3 \
	   docs/man/gearman_client_remove_servers.3 \
	   docs/man/gearman_client_run_tasks.3 \
	   docs/man/gearman_client_set_complete_fn.3 \
	   docs/man/gearman_client_set_context.3 \
	   docs/man/gearman_client_set_created_fn.3 \
	   docs/man/gearman_client_set_data_fn.3 \
	   docs/man/gearman_client_set_exception_fn.3 \
	   docs/man/gearman_client_set_fail_fn.3 \
	   docs/man/gearman_client_set_log_fn.3 \
	   docs/man/gearman_client_set_namespace.3 \
	   docs/man/gearman_client_set_options.3 \
	   docs/man/gearman_client_set_status_fn.3 \
	   docs/man/gearman_client_set_task_context_free_fn.3 \
	   docs/man/gearman_client_set_timeout.3 \
	   docs/man/gearman_client_set_warning_fn.3 \
	   docs/man/gearman_client_set_workload_fn.3 \
	   docs/man/gearman_client_set_workload_free_fn.3 \
	   docs/man/gearman_client_set_workload_malloc_fn.3 \
	   docs/man/gearman_client_st.3 \
	   docs/man/gearman_client_task_free_all.3 \
	   docs/man/gearman_client_timeout.3 \
	   docs/man/gearman_client_wait.3 \
	   docs/man/gearman_create.3 \
	   docs/man/gearman_execute.3 \
	   docs/man/gearman_execute_map_reduce.3 \
	   docs/man/gearman_job_free.3 \
	   docs/man/gearman_job_free_all.3 \
	   docs/man/gearman_job_function_name.3 \
	   docs/man/gearman_job_handle.3 \
	   docs/man/gearman_job_send_complete.3 \
	   docs/man/gearman_job_send_data.3 \
	   docs/man/gearman_job_send_exception.3 \
	   docs/man/gearman_job_send_fail.3 \
	   docs/man/gearman_job_send_status.3 \
	   docs/man/gearman_job_send_warning.3 \
	   docs/man/gearman_job_st.3 \
	   docs/man/gearman_job_take_workload.3 \
	   docs/man/gearman_job_unique.3 \
	   docs/man/gearman_job_workload.3 \
	   docs/man/gearman_job_workload_size.3 \
	   docs/man/gearman_parse_servers.3 \
	   docs/man/gearman_state_t.3 \
	   docs/man/gearman_task_context.3 \
	   docs/man/gearman_task_data.3 \
	   docs/man/gearman_task_data_size.3 \
	   docs/man/gearman_task_denominator.3 \
	   docs/man/gearman_task_free.3 \
	   docs/man/gearman_task_function_name.3 \
	   docs/man/gearman_task_give_workload.3 \
	   docs/man/gearman_task_is_known.3 \
	   docs/man/gearman_task_is_running.3 \
	   docs/man/gearman_task_job_handle.3 \
	   docs/man/gearman_task_numerator.3 \
	   docs/man/gearman_task_recv_data.3 \
	   docs/man/gearman_task_send_workload.3 \
	   docs/man/gearman_task_set_context.3 \
	   docs/man/gearman_task_st.3 \
	   docs/man/gearman_task_take_data.3 \
	   docs/man/gearman_task_unique.3 \
	   docs/man/gearman_unique_t.3 \
	   docs/man/gearman_verbose_name.3 \
	   docs/man/gearman_version.3 \
	   docs/man/gearman_worker_add_function.3 \
	   docs/man/gearman_worker_add_options.3 \
	   docs/man/gearman_worker_add_server.3 \
	   docs/man/gearman_worker_add_servers.3 \
	   docs/man/gearman_worker_clone.3 \
	   docs/man/gearman_worker_context.3 \
	   docs/man/gearman_worker_create.3 \
	   docs/man/gearman_worker_echo.3 \
	   docs/man/gearman_worker_errno.3 \
	   docs/man/gearman_worker_error.3 \
	   docs/man/gearman_worker_free.3 \
	   docs/man/gearman_worker_function_exist.3 \
	   docs/man/gearman_worker_grab_job.3 \
	   docs/man/gearman_worker_options.3 \
	   docs/man/gearman_worker_register.3 \
	   docs/man/gearman_worker_remove_options.3 \
	   docs/man/gearman_worker_remove_servers.3 \
	   docs/man/gearman_worker_set_context.3 \
	   docs/man/gearman_worker_set_log_fn.3 \
	   docs/man/gearman_worker_set_namespace.3 \
	   docs/man/gearman_worker_set_options.3 \
	   docs/man/gearman_worker_set_timeout.3 \
	   docs/man/gearman_worker_set_workload_free_fn.3 \
	   docs/man/gearman_worker_set_workload_malloc_fn.3 \
	   docs/man/gearman_worker_st.3 \
	   docs/man/gearman_worker_timeout.3 \
	   docs/man/gearman_worker_unregister.3 \
	   docs/man/gearman_worker_unregister_all.3 \
	   docs/man/gearman_worker_wait.3 \
	   docs/man/gearman_worker_work.3 \
	   docs/man/gearmand.8 \
	   docs/man/libgearman.3

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"
	@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)"

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."

dirhtml:
	PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/dirhtml
	@echo
	@echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/dirhtml."

singlehtml:
	PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/singlehtml
	@echo
	@echo "Build finished. The HTML page is in $(SPHINX_BUILDDIR)/singlehtml."

pickle:
	PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/pickle
	@echo
	@echo "Build finished; now you can process the pickle files."

json:
	PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/json
	@echo
	@echo "Build finished; now you can process the JSON files."

htmlhelp:
	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/Libmemcached.qhcp"
	@echo "To view the help file:"
	@echo "# assistant -collectionFile $(SPHINX_BUILDDIR)/qthelp/Libmemcached.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/Libmemcached"
	@echo "# ln -s $(SPHINX_BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Libmemcached"
	@echo "# devhelp"

epub:
	PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/epub
	@echo
	@echo "Build finished. The epub file is in $(SPHINX_BUILDDIR)/epub."

latex:
	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:
	PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/text
	@echo
	@echo "Build finished. The text files are in $(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."

changes:
	PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/changes
	@echo
	@echo "The overview file is in $(SPHINX_BUILDDIR)/changes."

linkcheck:
	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:
	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