2
# included from Top Level Makefile.am
3
# All paths should be given relative to the root
7
docs/hashkit_create.rst \
8
docs/hashkit_functions.rst \
9
docs/hashkit_value.rst \
12
docs/libmemcached.rst \
13
docs/libmemcached_configuration.rst \
14
docs/libmemcached_examples.rst \
15
docs/libmemcachedutil.rst \
17
docs/memcached_analyze.rst \
18
docs/memcached_auto.rst \
19
docs/memcached_behavior.rst \
20
docs/memcached_callback.rst \
21
docs/memcached_create.rst \
22
docs/memcached_delete.rst \
23
docs/memcached_dump.rst \
24
docs/memcached_flush.rst \
25
docs/memcached_flush_buffers.rst \
26
docs/memcached_generate_hash_value.rst \
27
docs/memcached_get.rst \
28
docs/memcached_memory_allocators.rst \
29
docs/memcached_pool.rst \
30
docs/memcached_quit.rst \
31
docs/memcached_result_st.rst \
32
docs/memcached_sasl.rst \
33
docs/memcached_server_st.rst \
34
docs/memcached_servers.rst \
35
docs/memcached_set.rst \
36
docs/memcached_stats.rst \
37
docs/memcached_strerror.rst \
38
docs/memcached_user_data.rst \
39
docs/memcached_verbosity.rst \
40
docs/memcached_version.rst \
51
# Makefile for Sphinx documentation
54
SPHINXOPTS = ${SPHINX_WARNINGS} -D release=${PANDORA_RELEASE_VERSION}
56
SPHINX_BUILDDIR = ${top_builddir}/docs
59
PAPEROPT_a4 = -D latex_paper_size=a4
60
PAPEROPT_letter = -D latex_paper_size=letter
61
ALLSPHINXOPTS = -d $(SPHINX_BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) ${top_srcdir}/docs
63
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
66
docs/man/hashkit_clone.3 \
67
docs/man/hashkit_crc32.3 \
68
docs/man/hashkit_create.3 \
69
docs/man/hashkit_fnv1_32.3 \
70
docs/man/hashkit_fnv1_64.3 \
71
docs/man/hashkit_fnv1a_32.3 \
72
docs/man/hashkit_fnv1a_64.3 \
73
docs/man/hashkit_free.3 \
74
docs/man/hashkit_functions.3 \
75
docs/man/hashkit_hsieh.3 \
76
docs/man/hashkit_is_allocated.3 \
77
docs/man/hashkit_jenkins.3 \
78
docs/man/hashkit_md5.3 \
79
docs/man/hashkit_murmur.3 \
80
docs/man/hashkit_value.3 \
81
docs/man/libhashkit.3 \
82
docs/man/libmemcached.3 \
83
docs/man/libmemcached_examples.3 \
84
docs/man/libmemcachedutil.3 \
86
docs/man/memcached_add.3 \
87
docs/man/memcached_add_by_key.3 \
88
docs/man/memcached_analyze.3 \
89
docs/man/memcached_append.3 \
90
docs/man/memcached_append_by_key.3 \
91
docs/man/memcached_behavior_get.3 \
92
docs/man/memcached_behavior_set.3 \
93
docs/man/memcached_callback_get.3 \
94
docs/man/memcached_callback_set.3 \
95
docs/man/memcached_cas.3 \
96
docs/man/memcached_cas_by_key.3 \
97
docs/man/memcached_clone.3 \
98
docs/man/memcached_create.3 \
99
docs/man/memcached_decrement.3 \
100
docs/man/memcached_decrement_with_initial.3 \
101
docs/man/memcached_delete.3 \
102
docs/man/memcached_delete_by_key.3 \
103
docs/man/memcached_destroy_sasl_auth_data.3 \
104
docs/man/memcached_dump.3 \
105
docs/man/memcached_fetch.3 \
106
docs/man/memcached_fetch_execute.3 \
107
docs/man/memcached_fetch_result.3 \
108
docs/man/memcached_flush_buffers.3 \
109
docs/man/memcached_free.3 \
110
docs/man/memcached_generate_hash.3 \
111
docs/man/libmemcached_check_configuration.3 \
112
docs/man/libmemcached_configuration.3 \
113
docs/man/memcached_create_with_options.3 \
114
docs/man/memcached_generate_hash_value.3 \
115
docs/man/memcached_get.3 \
116
docs/man/memcached_get_by_key.3 \
117
docs/man/memcached_get_memory_allocators.3 \
118
docs/man/memcached_get_sasl_callbacks.3 \
119
docs/man/memcached_get_user_data.3 \
120
docs/man/memcached_increment.3 \
121
docs/man/memcached_increment_with_initial.3 \
122
docs/man/memcached_lib_version.3 \
123
docs/man/memcached_mget.3 \
124
docs/man/memcached_mget_by_key.3 \
125
docs/man/memcached_mget_execute.3 \
126
docs/man/memcached_mget_execute_by_key.3 \
127
docs/man/memcached_pool_behavior_get.3 \
128
docs/man/memcached_pool_behavior_set.3 \
129
docs/man/memcached_pool_create.3 \
130
docs/man/memcached_pool_destroy.3 \
131
docs/man/memcached_pool_pop.3 \
132
docs/man/memcached_pool_push.3 \
133
docs/man/memcached_prepend.3 \
134
docs/man/memcached_prepend_by_key.3 \
135
docs/man/memcached_quit.3 \
136
docs/man/memcached_replace.3 \
137
docs/man/memcached_replace_by_key.3 \
138
docs/man/memcached_sasl_set_auth_data.3 \
139
docs/man/memcached_server_add.3 \
140
docs/man/memcached_server_count.3 \
141
docs/man/memcached_server_cursor.3 \
142
docs/man/memcached_server_list.3 \
143
docs/man/memcached_server_list_append.3 \
144
docs/man/memcached_server_list_count.3 \
145
docs/man/memcached_server_list_free.3 \
146
docs/man/memcached_server_push.3 \
147
docs/man/memcached_servers_parse.3 \
148
docs/man/memcached_set.3 \
149
docs/man/memcached_set_by_key.3 \
150
docs/man/memcached_set_memory_allocators.3 \
151
docs/man/memcached_set_sasl_callbacks.3 \
152
docs/man/memcached_set_user_data.3 \
153
docs/man/memcached_stat.3 \
154
docs/man/memcached_stat_execute.3 \
155
docs/man/memcached_stat_get_keys.3 \
156
docs/man/memcached_stat_get_value.3 \
157
docs/man/memcached_stat_servername.3 \
158
docs/man/memcached_strerror.3 \
159
docs/man/memcached_verbosity.3 \
160
docs/man/memcached_version.3 \
161
docs/man/memcapable.1 \
165
docs/man/memerror.1 \
166
docs/man/memflush.1 \
174
@echo "Please use \`make <target>' where <target> is one of"
175
@echo " html to make standalone HTML files"
176
@echo " dirhtml to make HTML files named index.html in directories"
177
@echo " singlehtml to make a single large HTML file"
178
@echo " pickle to make pickle files"
179
@echo " json to make JSON files"
180
@echo " htmlhelp to make HTML files and a HTML help project"
181
@echo " qthelp to make HTML files and a qthelp project"
182
@echo " devhelp to make HTML files and a Devhelp project"
183
@echo " epub to make an epub"
184
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
185
@echo " latexpdf to make LaTeX files and run them through pdflatex"
186
@echo " text to make text files"
187
@echo " man to make manual pages"
188
@echo " changes to make an overview of all changed/added/deprecated items"
189
@echo " linkcheck to check all external links for integrity"
190
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
193
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/html
195
@echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/html."
198
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/dirhtml
200
@echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/dirhtml."
203
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/singlehtml
205
@echo "Build finished. The HTML page is in $(SPHINX_BUILDDIR)/singlehtml."
208
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/pickle
210
@echo "Build finished; now you can process the pickle files."
213
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/json
215
@echo "Build finished; now you can process the JSON files."
218
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/htmlhelp
220
@echo "Build finished; now you can run HTML Help Workshop with the" \
221
".hhp project file in $(SPHINX_BUILDDIR)/htmlhelp."
224
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/qthelp
226
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
227
".qhcp project file in $(SPHINX_BUILDDIR)/qthelp, like this:"
228
@echo "# qcollectiongenerator $(SPHINX_BUILDDIR)/qthelp/Libmemcached.qhcp"
229
@echo "To view the help file:"
230
@echo "# assistant -collectionFile $(SPHINX_BUILDDIR)/qthelp/Libmemcached.qhc"
233
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/devhelp
235
@echo "Build finished."
236
@echo "To view the help file:"
237
@echo "# mkdir -p $$HOME/.local/share/devhelp/Libmemcached"
238
@echo "# ln -s $(SPHINX_BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Libmemcached"
242
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/epub
244
@echo "Build finished. The epub file is in $(SPHINX_BUILDDIR)/epub."
247
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
249
@echo "Build finished; the LaTeX files are in $(SPHINX_BUILDDIR)/latex."
250
@echo "Run \`make' in that directory to run these through (pdf)latex" \
251
"(use \`make latexpdf' here to do that automatically)."
254
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
255
@echo "Running LaTeX files through pdflatex..."
256
make -C $(SPHINX_BUILDDIR)/latex all-pdf
257
@echo "pdflatex finished; the PDF files are in $(SPHINX_BUILDDIR)/latex."
260
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/text
262
@echo "Build finished. The text files are in $(SPHINX_BUILDDIR)/text."
265
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/man
267
@echo "Build finished. The manual pages are in $(SPHINX_BUILDDIR)/man."
270
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/changes
272
@echo "The overview file is in $(SPHINX_BUILDDIR)/changes."
275
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/linkcheck
277
@echo "Link check complete; look for any errors in the above output " \
278
"or in $(SPHINX_BUILDDIR)/linkcheck/output.txt."
281
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/doctest
282
@echo "Testing of doctests in the sources finished, look at the " \
283
"results in $(SPHINX_BUILDDIR)/doctest/output.txt."
added
removed
docs/include.am
