2
# included from Top Level Makefile.am
3
# All paths should be given relative to the root
5
# Makefile for Sphinx documentation
8
SPHINXOPTS = ${SPHINX_WARNINGS} -q
10
SPHINX_BUILDDIR = ${abs_top_builddir}/docs
13
PAPEROPT_a4 = -D latex_paper_size=a4
14
PAPEROPT_letter = -D latex_paper_size=letter
15
ALLSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SPHINX_BUILDDIR)
17
.PHONY: clean-docs-check
19
-rm -rf docs/_build docs/doctrees man/.doctrees/
21
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
25
@echo "Please use \`make <target>' where <target> is one of"
26
@echo " html to make standalone HTML files"
27
@echo " dirhtml to make HTML files named index.html in directories"
28
@echo " singlehtml to make a single large HTML file"
29
@echo " pickle to make pickle files"
30
@echo " json to make JSON files"
31
@echo " htmlhelp to make HTML files and a HTML help project"
32
@echo " qthelp to make HTML files and a qthelp project"
33
@echo " devhelp to make HTML files and a Devhelp project"
34
@echo " epub to make an epub"
35
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
36
@echo " latexpdf to make LaTeX files and run them through pdflatex"
37
@echo " text to make text files"
38
@echo " man to make manual pages"
39
@echo " changes to make an overview of all changed/added/deprecated items"
40
@echo " linkcheck to check all external links for integrity"
41
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
44
@$(mkdir_p) $(SPHINX_BUILDDIR)/_static
46
html-local: docs/conf.py docs changes doc_dirs
47
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/html
49
@echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/html."
52
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/dirhtml
54
@echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/dirhtml."
56
singlehtml: html-local
57
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/singlehtml
59
@echo "Build finished. The HTML page is in $(SPHINX_BUILDDIR)/singlehtml."
62
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/pickle
64
@echo "Build finished; now you can process the pickle files."
67
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/json
69
@echo "Build finished; now you can process the JSON files."
71
htmlhelp: docs/conf.py
72
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/htmlhelp
74
@echo "Build finished; now you can run HTML Help Workshop with the" \
75
".hhp project file in $(SPHINX_BUILDDIR)/htmlhelp."
78
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/qthelp
80
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
81
".qhcp project file in $(SPHINX_BUILDDIR)/qthelp, like this:"
82
@echo "# qcollectiongenerator $(SPHINX_BUILDDIR)/qthelp/Libmemcached.qhcp"
83
@echo "To view the help file:"
84
@echo "# assistant -collectionFile $(SPHINX_BUILDDIR)/qthelp/Libmemcached.qhc"
87
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/devhelp
89
@echo "Build finished."
90
@echo "To view the help file:"
91
@echo "# mkdir -p $$HOME/.local/share/devhelp/Libmemcached"
92
@echo "# ln -s $(SPHINX_BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Libmemcached"
96
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/epub
98
@echo "Build finished. The epub file is in $(SPHINX_BUILDDIR)/epub."
101
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
103
@echo "Build finished; the LaTeX files are in $(SPHINX_BUILDDIR)/latex."
104
@echo "Run \`make' in that directory to run these through (pdf)latex" \
105
"(use \`make latexpdf' here to do that automatically)."
108
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
109
@echo "Running LaTeX files through pdflatex..."
110
make -C $(SPHINX_BUILDDIR)/latex all-pdf
111
@echo "pdflatex finished; the PDF files are in $(SPHINX_BUILDDIR)/latex."
114
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/text
116
@echo "Build finished. The text files are in $(SPHINX_BUILDDIR)/text."
118
if HAVE_RECENT_SPHINX
120
PYTHONPATH=$(SPHINX_BUILDDIR)/docs $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) ${top_builddir}/man
128
changes: docs/conf.py
129
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/changes
131
@echo "The overview file is in $(SPHINX_BUILDDIR)/changes."
133
linkcheck: docs/conf.py
134
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/linkcheck
136
@echo "Link check complete; look for any errors in the above output " \
137
"or in $(SPHINX_BUILDDIR)/linkcheck/output.txt."
139
doctest: docs/conf.py
140
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/doctest
141
@echo "Testing of doctests in the sources finished, look at the " \
142
"results in $(SPHINX_BUILDDIR)/doctest/output.txt."
150
noinst_PROGRAMS+= docs/libgearman/examples/gearman_client_do_background_example
151
noinst_PROGRAMS+= docs/libgearman/examples/gearman_client_do_example
152
noinst_PROGRAMS+= docs/libgearman/examples/gearman_execute_example
153
noinst_PROGRAMS+= docs/libgearman/examples/gearman_execute_partition
155
docs_libgearman_examples_gearman_execute_example_SOURCES= docs/libgearman/examples/gearman_execute_example.c
156
docs_libgearman_examples_gearman_execute_example_LDADD= libgearman/libgearman.la
158
docs_libgearman_examples_gearman_execute_partition_SOURCES= docs/libgearman/examples/gearman_execute_partition.c
159
docs_libgearman_examples_gearman_execute_partition_LDADD= libgearman/libgearman.la
161
docs_libgearman_examples_gearman_client_do_example_SOURCES= docs/libgearman/examples/gearman_client_do_example.c
162
docs_libgearman_examples_gearman_client_do_example_LDADD= libgearman/libgearman.la
164
docs_libgearman_examples_gearman_client_do_background_example_SOURCES= docs/libgearman/examples/gearman_client_do_background_example.c
165
docs_libgearman_examples_gearman_client_do_background_example_LDADD= libgearman/libgearman.la
added
removed
docs/include.am
