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 \
52 # Makefile for Sphinx documentation
55 SPHINXOPTS = ${SPHINX_WARNINGS} -D release=${PANDORA_RELEASE_VERSION}
57 SPHINX_BUILDDIR = ${top_builddir}/docs
60 PAPEROPT_a4 = -D latex_paper_size=a4
61 PAPEROPT_letter = -D latex_paper_size=letter
62 ALLSPHINXOPTS = -d $(SPHINX_BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) ${top_srcdir}/docs
64 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
67 docs/man/hashkit_clone.3 \
68 docs/man/hashkit_crc32.3 \
69 docs/man/hashkit_create.3 \
70 docs/man/hashkit_fnv1_32.3 \
71 docs/man/hashkit_fnv1_64.3 \
72 docs/man/hashkit_fnv1a_32.3 \
73 docs/man/hashkit_fnv1a_64.3 \
74 docs/man/hashkit_free.3 \
75 docs/man/hashkit_functions.3 \
76 docs/man/hashkit_hsieh.3 \
77 docs/man/hashkit_is_allocated.3 \
78 docs/man/hashkit_jenkins.3 \
79 docs/man/hashkit_md5.3 \
80 docs/man/hashkit_murmur.3 \
81 docs/man/hashkit_value.3 \
82 docs/man/libhashkit.3 \
83 docs/man/libmemcached.3 \
84 docs/man/libmemcached_examples.3 \
85 docs/man/libmemcachedutil.3 \
87 docs/man/memcached_add.3 \
88 docs/man/memcached_add_by_key.3 \
89 docs/man/memcached_analyze.3 \
90 docs/man/memcached_append.3 \
91 docs/man/memcached_append_by_key.3 \
92 docs/man/memcached_behavior_get.3 \
93 docs/man/memcached_behavior_set.3 \
94 docs/man/memcached_callback_get.3 \
95 docs/man/memcached_callback_set.3 \
96 docs/man/memcached_cas.3 \
97 docs/man/memcached_cas_by_key.3 \
98 docs/man/memcached_clone.3 \
99 docs/man/memcached_create.3 \
100 docs/man/memcached_decrement.3 \
101 docs/man/memcached_decrement_with_initial.3 \
102 docs/man/memcached_delete.3 \
103 docs/man/memcached_delete_by_key.3 \
104 docs/man/memcached_destroy_sasl_auth_data.3 \
105 docs/man/memcached_dump.3 \
106 docs/man/memcached_fetch.3 \
107 docs/man/memcached_fetch_execute.3 \
108 docs/man/memcached_fetch_result.3 \
109 docs/man/memcached_flush_buffers.3 \
110 docs/man/memcached_free.3 \
111 docs/man/memcached_generate_hash.3 \
112 docs/man/libmemcached_check_configuration.3 \
113 docs/man/libmemcached_configuration.3 \
114 docs/man/memcached.3 \
115 docs/man/memcached_generate_hash_value.3 \
116 docs/man/memcached_get.3 \
117 docs/man/memcached_get_by_key.3 \
118 docs/man/memcached_get_memory_allocators.3 \
119 docs/man/memcached_get_sasl_callbacks.3 \
120 docs/man/memcached_get_user_data.3 \
121 docs/man/memcached_increment.3 \
122 docs/man/memcached_increment_with_initial.3 \
123 docs/man/memcached_lib_version.3 \
124 docs/man/memcached_mget.3 \
125 docs/man/memcached_mget_by_key.3 \
126 docs/man/memcached_mget_execute.3 \
127 docs/man/memcached_mget_execute_by_key.3 \
128 docs/man/memcached_pool_behavior_get.3 \
129 docs/man/memcached_pool_behavior_set.3 \
130 docs/man/memcached_pool_create.3 \
131 docs/man/memcached_pool_destroy.3 \
132 docs/man/memcached_pool_pop.3 \
133 docs/man/memcached_pool_push.3 \
134 docs/man/memcached_pool_st.3 \
135 docs/man/memcached_prepend.3 \
136 docs/man/memcached_prepend_by_key.3 \
137 docs/man/memcached_quit.3 \
138 docs/man/memcached_replace.3 \
139 docs/man/memcached_replace_by_key.3 \
140 docs/man/memcached_sasl_set_auth_data.3 \
141 docs/man/memcached_server_add.3 \
142 docs/man/memcached_server_count.3 \
143 docs/man/memcached_server_cursor.3 \
144 docs/man/memcached_server_list.3 \
145 docs/man/memcached_server_list_append.3 \
146 docs/man/memcached_server_list_count.3 \
147 docs/man/memcached_server_list_free.3 \
148 docs/man/memcached_server_push.3 \
149 docs/man/memcached_servers_parse.3 \
150 docs/man/memcached_set.3 \
151 docs/man/memcached_set_by_key.3 \
152 docs/man/memcached_set_memory_allocators.3 \
153 docs/man/memcached_set_sasl_callbacks.3 \
154 docs/man/memcached_set_user_data.3 \
155 docs/man/memcached_stat.3 \
156 docs/man/memcached_stat_execute.3 \
157 docs/man/memcached_stat_get_keys.3 \
158 docs/man/memcached_stat_get_value.3 \
159 docs/man/memcached_stat_servername.3 \
160 docs/man/memcached_strerror.3 \
161 docs/man/memcached_verbosity.3 \
162 docs/man/memcached_version.3 \
163 docs/man/memcapable.1 \
167 docs/man/memerror.1 \
168 docs/man/memflush.1 \
176 @echo "Please use \`make <target>' where <target> is one of"
177 @echo " html to make standalone HTML files"
178 @echo " dirhtml to make HTML files named index.html in directories"
179 @echo " singlehtml to make a single large HTML file"
180 @echo " pickle to make pickle files"
181 @echo " json to make JSON files"
182 @echo " htmlhelp to make HTML files and a HTML help project"
183 @echo " qthelp to make HTML files and a qthelp project"
184 @echo " devhelp to make HTML files and a Devhelp project"
185 @echo " epub to make an epub"
186 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
187 @echo " latexpdf to make LaTeX files and run them through pdflatex"
188 @echo " text to make text files"
189 @echo " man to make manual pages"
190 @echo " changes to make an overview of all changed/added/deprecated items"
191 @echo " linkcheck to check all external links for integrity"
192 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
195 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/html
197 @echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/html."
200 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/dirhtml
202 @echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/dirhtml."
205 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/singlehtml
207 @echo "Build finished. The HTML page is in $(SPHINX_BUILDDIR)/singlehtml."
210 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/pickle
212 @echo "Build finished; now you can process the pickle files."
215 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/json
217 @echo "Build finished; now you can process the JSON files."
220 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/htmlhelp
222 @echo "Build finished; now you can run HTML Help Workshop with the" \
223 ".hhp project file in $(SPHINX_BUILDDIR)/htmlhelp."
226 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/qthelp
228 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
229 ".qhcp project file in $(SPHINX_BUILDDIR)/qthelp, like this:"
230 @echo "# qcollectiongenerator $(SPHINX_BUILDDIR)/qthelp/Libmemcached.qhcp"
231 @echo "To view the help file:"
232 @echo "# assistant -collectionFile $(SPHINX_BUILDDIR)/qthelp/Libmemcached.qhc"
235 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/devhelp
237 @echo "Build finished."
238 @echo "To view the help file:"
239 @echo "# mkdir -p $$HOME/.local/share/devhelp/Libmemcached"
240 @echo "# ln -s $(SPHINX_BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Libmemcached"
244 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/epub
246 @echo "Build finished. The epub file is in $(SPHINX_BUILDDIR)/epub."
249 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
251 @echo "Build finished; the LaTeX files are in $(SPHINX_BUILDDIR)/latex."
252 @echo "Run \`make' in that directory to run these through (pdf)latex" \
253 "(use \`make latexpdf' here to do that automatically)."
256 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
257 @echo "Running LaTeX files through pdflatex..."
258 make -C $(SPHINX_BUILDDIR)/latex all-pdf
259 @echo "pdflatex finished; the PDF files are in $(SPHINX_BUILDDIR)/latex."
262 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/text
264 @echo "Build finished. The text files are in $(SPHINX_BUILDDIR)/text."
267 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/man
269 @echo "Build finished. The manual pages are in $(SPHINX_BUILDDIR)/man."
272 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/changes
274 @echo "The overview file is in $(SPHINX_BUILDDIR)/changes."
277 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/linkcheck
279 @echo "Link check complete; look for any errors in the above output " \
280 "or in $(SPHINX_BUILDDIR)/linkcheck/output.txt."
283 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/doctest
284 @echo "Testing of doctests in the sources finished, look at the " \
285 "results in $(SPHINX_BUILDDIR)/doctest/output.txt."