Style cleanup
[m6w6/libmemcached] / docs / conf.py.in
1 # -*- coding: utf-8 -*-
2 #
3 # libmemcached documentation build configuration file, created by
4 # sphinx-quickstart on Sun Mar 6 12:05:53 2011.
5 #
6 # This file is execfile()d with the current directory set to its containing dir.
7 #
8 # Note that not all possible configuration values are present in this
9 # autogenerated file.
10 #
11 # All configuration values have a default; values that are commented out
12 # serve to show the default.
13
14 import sys, os
15
16 # If extensions (or modules to document with autodoc) are in another directory,
17 # add these directories to sys.path here. If the directory is relative to the
18 # documentation root, use os.path.abspath to make it absolute, like shown here.
19 #sys.path.insert(0, os.path.abspath('.'))
20
21 # -- General configuration -----------------------------------------------------
22
23 # If your documentation needs a minimal Sphinx version, state it here.
24 #needs_sphinx = '1.0'
25
26 # Add any Sphinx extension module names here, as strings. They can be extensions
27 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
28 extensions = []
29
30 extensions = ['sphinxcontrib.googleanalytics']
31
32 # Google
33 googleanalytics_id = 'UA-15307604-2'
34 googleanalytics_enabled = 'True'
35
36 # Add any paths that contain templates here, relative to this directory.
37 templates_path = ['_templates']
38
39 # The suffix of source filenames.
40 source_suffix = '.rst'
41
42 # The encoding of source files.
43 #source_encoding = 'utf-8-sig'
44
45 # The master toctree document.
46 master_doc = 'index'
47
48 # General information about the project.
49 project = u'libmemcached'
50 copyright = u'2011, Brian Aker DataDifferential, http://datadifferential.com/'
51
52 # The version info for the project you're documenting, acts as replacement for
53 # |version| and |release|, also used in various other places throughout the
54 # built documents.
55 #
56 # The short X.Y version.
57 version = '@VERSION@'
58 # The full version, including alpha/beta/rc tags.
59 release = '@VERSION@'
60
61 # The language for content autogenerated by Sphinx. Refer to documentation
62 # for a list of supported languages.
63 #language = None
64
65 # There are two options for replacing |today|: either, you set today to some
66 # non-false value, then it is used:
67 #today = ''
68 # Else, today_fmt is used as the format for a strftime call.
69 #today_fmt = '%B %d, %Y'
70
71 # List of patterns, relative to source directory, that match files and
72 # directories to ignore when looking for source files.
73 exclude_patterns = ['_build']
74
75 # The reST default role (used for this markup: `text`) to use for all documents.
76 #default_role = None
77
78 # If true, '()' will be appended to :func: etc. cross-reference text.
79 #add_function_parentheses = True
80
81 # If true, the current module name will be prepended to all description
82 # unit titles (such as .. function::).
83 #add_module_names = True
84
85 # If true, sectionauthor and moduleauthor directives will be shown in the
86 # output. They are ignored by default.
87 #show_authors = False
88
89 # The name of the Pygments (syntax highlighting) style to use.
90 pygments_style = 'sphinx'
91
92 # A list of ignored prefixes for module index sorting.
93 #modindex_common_prefix = []
94
95
96 # -- Options for HTML output ---------------------------------------------------
97
98 # The theme to use for HTML and HTML Help pages. See the documentation for
99 # a list of builtin themes.
100 html_theme = 'default'
101
102 # Theme options are theme-specific and customize the look and feel of a theme
103 # further. For a list of options available for each theme, see the
104 # documentation.
105 #html_theme_options = {}
106
107 # Add any paths that contain custom themes here, relative to this directory.
108 #html_theme_path = []
109
110 # The name for this set of Sphinx documents. If None, it defaults to
111 # "<project> v<release> documentation".
112 #html_title = None
113
114 # A shorter title for the navigation bar. Default is the same as html_title.
115 #html_short_title = None
116
117 # The name of an image file (relative to this directory) to place at the top
118 # of the sidebar.
119 #html_logo = None
120
121 # The name of an image file (within the static path) to use as favicon of the
122 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
123 # pixels large.
124 #html_favicon = None
125
126 # Add any paths that contain custom static files (such as style sheets) here,
127 # relative to this directory. They are copied after the builtin static files,
128 # so a file named "default.css" will overwrite the builtin "default.css".
129 html_static_path = ['_static']
130
131 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
132 # using the given strftime format.
133 #html_last_updated_fmt = '%b %d, %Y'
134
135 # If true, SmartyPants will be used to convert quotes and dashes to
136 # typographically correct entities.
137 #html_use_smartypants = True
138
139 # Custom sidebar templates, maps document names to template names.
140 #html_sidebars = {}
141
142 # Additional templates that should be rendered to pages, maps page names to
143 # template names.
144 #html_additional_pages = {}
145
146 # If false, no module index is generated.
147 #html_domain_indices = True
148
149 # If false, no index is generated.
150 #html_use_index = True
151
152 # If true, the index is split into individual pages for each letter.
153 #html_split_index = False
154
155 # If true, links to the reST sources are added to the pages.
156 html_show_sourcelink = False
157
158 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
159 #html_show_sphinx = True
160
161 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
162 #html_show_copyright = True
163
164 # If true, an OpenSearch description file will be output, and all pages will
165 # contain a <link> tag referring to it. The value of this option must be the
166 # base URL from which the finished HTML is served.
167 #html_use_opensearch = ''
168
169 # This is the file name suffix for HTML files (e.g. ".xhtml").
170 #html_file_suffix = None
171
172 # Output file base name for HTML help builder.
173 htmlhelp_basename = 'libmemcacheddoc'
174
175
176 # -- Options for LaTeX output --------------------------------------------------
177
178 # The paper size ('letter' or 'a4').
179 #latex_paper_size = 'letter'
180
181 # The font size ('10pt', '11pt' or '12pt').
182 #latex_font_size = '10pt'
183
184 # Grouping the document tree into LaTeX files. List of tuples
185 # (source start file, target name, title, author, documentclass [howto/manual]).
186 latex_documents = [
187 ('index', 'libmemcached.tex', u'libmemcached Documentation',
188 u'Brian Aker', 'manual'),
189 ]
190
191 # The name of an image file (relative to this directory) to place at the top of
192 # the title page.
193 #latex_logo = None
194
195 # For "manual" documents, if this is true, then toplevel headings are parts,
196 # not chapters.
197 #latex_use_parts = False
198
199 # If true, show page references after internal links.
200 #latex_show_pagerefs = False
201
202 # If true, show URL addresses after external links.
203 #latex_show_urls = False
204
205 # Additional stuff for the LaTeX preamble.
206 #latex_preamble = ''
207
208 # Documents to append as an appendix to all manuals.
209 #latex_appendices = []
210
211 # If false, no module index is generated.
212 #latex_domain_indices = True
213
214
215 # -- Options for manual page output --------------------------------------------
216
217 # One entry per manual page. List of tuples
218 # (source start file, name, description, authors, manual section).
219 man_pages = [
220 ('hashkit_create', 'hashkit_clone', u'libhashkit Documentation', [u'Brian Aker'], 3),
221 ('hashkit_create', 'hashkit_create', u'libhashkit Documentation', [u'Brian Aker'], 3),
222 ('hashkit_create', 'hashkit_free', u'libhashkit Documentation', [u'Brian Aker'], 3),
223 ('hashkit_create', 'hashkit_is_allocated', u'libhashkit Documentation', [u'Brian Aker'], 3),
224 ('hashkit_functions', 'hashkit_crc32', u'libhashkit Documentation', [u'Brian Aker'], 3),
225 ('hashkit_functions', 'hashkit_fnv1_32', u'libhashkit Documentation', [u'Brian Aker'], 3),
226 ('hashkit_functions', 'hashkit_fnv1_64', u'libhashkit Documentation', [u'Brian Aker'], 3),
227 ('hashkit_functions', 'hashkit_fnv1a_32', u'libhashkit Documentation', [u'Brian Aker'], 3),
228 ('hashkit_functions', 'hashkit_fnv1a_64', u'libhashkit Documentation', [u'Brian Aker'], 3),
229 ('hashkit_functions', 'hashkit_functions', u'libhashkit Documentation', [u'Brian Aker'], 3),
230 ('hashkit_functions', 'hashkit_hsieh', u'libhashkit Documentation', [u'Brian Aker'], 3),
231 ('hashkit_functions', 'hashkit_jenkins', u'libhashkit Documentation', [u'Brian Aker'], 3),
232 ('hashkit_functions', 'hashkit_md5', u'libhashkit Documentation', [u'Brian Aker'], 3),
233 ('hashkit_functions', 'hashkit_murmur', u'libhashkit Documentation', [u'Brian Aker'], 3),
234 ('hashkit_value', 'hashkit_value', u'libhashkit Documentation', [u'Brian Aker'], 3),
235 ('libhashkit', 'libhashkit', u'libhashkit Documentation', [u'Brian Aker'], 3),
236 ('libmemcached', 'libmemcached', u'Introducing the C Client Library for memcached', [u'Brian Aker'], 3),
237 ('libmemcached_configuration', 'libmemcached_check_configuration', u'libmemcached Documentation', [u'Brian Aker'], 3),
238 ('libmemcached_configuration', 'libmemcached_configuration', u'libmemcached Documentation', [u'Brian Aker'], 3),
239 ('libmemcached_configuration', 'memcached', u'libmemcached Documentation', [u'Brian Aker'], 3),
240 ('libmemcached_examples', 'libmemcached_examples', u'libmemcached Documentation', [u'Brian Aker'], 3),
241 ('libmemcachedutil', 'libmemcachedutil', u'libmemcached Documentation', [u'Brian Aker'], 3),
242 ('memcached_analyze', 'memcached_analyze', u'libmemcached Documentation', [u'Brian Aker'], 3),
243 ('memcached_append', 'memcached_append', u'Appending to or Prepending to data on the server', [u'Brian Aker'], 3),
244 ('memcached_append', 'memcached_append_by_key', u'Appending to or Prepending to data on the server', [u'Brian Aker'], 3),
245 ('memcached_append', 'memcached_prepend', u'Appending to or Prepending to data on the server', [u'Brian Aker'], 3),
246 ('memcached_append', 'memcached_prepend_by_key', u'Appending to or Prepending to data on the server', [u'Brian Aker'], 3),
247 ('memcached_auto', 'memcached_auto', u'Incrementing and Decrementing Values', [u'Brian Aker'], 3),
248 ('memcached_auto', 'memcached_decrement', u'Incrementing and Decrementing Values', [u'Brian Aker'], 3),
249 ('memcached_auto', 'memcached_decrement_with_initial', u'Incrementing and Decrementing Values', [u'Brian Aker'], 3),
250 ('memcached_auto', 'memcached_increment', u'Incrementing and Decrementing Values', [u'Brian Aker'], 3),
251 ('memcached_auto', 'memcached_increment_with_initial', u'Incrementing and Decrementing Values', [u'Brian Aker'], 3),
252 ('memcached_behavior', 'memcached_behavior', u'libmemcached Documentation', [u'Brian Aker'], 3),
253 ('memcached_behavior', 'memcached_behavior_get', u'libmemcached Documentation', [u'Brian Aker'], 3),
254 ('memcached_behavior', 'memcached_behavior_set', u'libmemcached Documentation', [u'Brian Aker'], 3),
255 ('memcached_callback', 'memcached_callback', u'libmemcached Documentation', [u'Brian Aker'], 3),
256 ('memcached_callback', 'memcached_callback_get', u'libmemcached Documentation', [u'Brian Aker'], 3),
257 ('memcached_callback', 'memcached_callback_set', u'libmemcached Documentation', [u'Brian Aker'], 3),
258 ('memcached_cas', 'memcached_cas', u'Working with data on the server in an atomic fashion', [u'Brian Aker'], 3),
259 ('memcached_cas', 'memcached_cas_by_key', u'Storing and Replacing Data', [u'Brian Aker'], 3),
260 ('memcached_create', 'memcached_clone', u'libmemcached Documentation', [u'Brian Aker'], 3),
261 ('memcached_create', 'memcached_create', u'libmemcached Documentation', [u'Brian Aker'], 3),
262 ('memcached_create', 'memcached_free', u'libmemcached Documentation', [u'Brian Aker'], 3),
263 ('memcached_create', 'memcached_servers_reset', u'libmemcached Documentation', [u'Brian Aker'], 3),
264 ('memcached_delete', 'memcached_delete', u'libmemcached Documentation', [u'Brian Aker'], 3),
265 ('memcached_delete', 'memcached_delete_by_key', u'libmemcached Documentation', [u'Brian Aker'], 3),
266 ('memcached_dump', 'memcached_dump', u'libmemcached Documentation', [u'Brian Aker'], 3),
267 ('memcached_flush', 'memcached_flush', u'libmemcached Documentation', [u'Brian Aker'], 3),
268 ('memcached_flush_buffers', 'memcached_flush_buffers', u'libmemcached Documentation', [u'Brian Aker'], 3),
269 ('memcached_generate_hash_value', 'memcached_generate_hash', u'Generating hash values directly', [u'Brian Aker'], 3),
270 ('memcached_generate_hash_value', 'memcached_generate_hash_value', u'Generating hash values directly', [u'Brian Aker'], 3),
271 ('libmemcached/memcached_fetch', 'memcached_fetch', u'Retrieving data from the server', [u'Brian Aker'], 3),
272 ('memcached_get', 'memcached_fetch_execute', u'Retrieving data from the server', [u'Brian Aker'], 3),
273 ('memcached_get', 'memcached_fetch_result', u'Retrieving data from the server', [u'Brian Aker'], 3),
274 ('memcached_get', 'memcached_get', u'Retrieving data from the server', [u'Brian Aker'], 3),
275 ('memcached_get', 'memcached_get_by_key', u'Retrieving data from the server', [u'Brian Aker'], 3),
276 ('memcached_get', 'memcached_mget', u'Retrieving data from the server', [u'Brian Aker'], 3),
277 ('memcached_get', 'memcached_mget_by_key', u'Retrieving data from the server', [u'Brian Aker'], 3),
278 ('memcached_get', 'memcached_mget_execute', u'Retrieving data from the server', [u'Brian Aker'], 3),
279 ('memcached_get', 'memcached_mget_execute_by_key', u'Retrieving data from the server', [u'Brian Aker'], 3),
280 ('memcached_memory_allocators', 'memcached_get_memory_allocators', u'libmemcached Documentation', [u'Brian Aker'], 3),
281 ('memcached_memory_allocators', 'memcached_memory_allocators', u'libmemcached Documentation', [u'Brian Aker'], 3),
282 ('memcached_memory_allocators', 'memcached_set_memory_allocators', u'libmemcached Documentation', [u'Brian Aker'], 3),
283 ('memcached_memory_allocators', 'memcached_set_memory_allocators_context', u'libmemcached Documentation', [u'Brian Aker'], 3),
284 ('memcached_pool', 'memcached_pool', u'libmemcached Documentation', [u'Brian Aker'], 3),
285 ('memcached_pool', 'memcached_pool_behavior_get', u'libmemcached Documentation', [u'Brian Aker'], 3),
286 ('memcached_pool', 'memcached_pool_behavior_set', u'libmemcached Documentation', [u'Brian Aker'], 3),
287 ('memcached_pool', 'memcached_pool_create', u'libmemcached Documentation', [u'Brian Aker'], 3),
288 ('memcached_pool', 'memcached_pool_destroy', u'libmemcached Documentation', [u'Brian Aker'], 3),
289 ('memcached_pool', 'memcached_pool_pop', u'libmemcached Documentation', [u'Brian Aker'], 3),
290 ('memcached_pool', 'memcached_pool_push', u'libmemcached Documentation', [u'Brian Aker'], 3),
291 ('memcached_pool', 'memcached_pool_push', u'libmemcached Documentation', [u'Brian Aker'], 3),
292 ('memcached_pool', 'memcached_pool_st', u'libmemcached Documentation', [u'Brian Aker'], 3),
293 ('memcached_quit', 'memcached_quit', u'libmemcached Documentation', [u'Brian Aker'], 3),
294 ('memcached_result_st', 'memcached_result_cas', u'Working with result sets', [u'Brian Aker'], 3),
295 ('memcached_result_st', 'memcached_result_create', u'Working with result sets', [u'Brian Aker'], 3),
296 ('memcached_result_st', 'memcached_result_flags', u'Working with result sets', [u'Brian Aker'], 3),
297 ('memcached_result_st', 'memcached_result_free', u'Working with result sets', [u'Brian Aker'], 3),
298 ('memcached_result_st', 'memcached_result_key_length', u'Working with result sets', [u'Brian Aker'], 3),
299 ('memcached_result_st', 'memcached_result_key_value', u'Working with result sets', [u'Brian Aker'], 3),
300 ('memcached_result_st', 'memcached_result_length', u'Working with result sets', [u'Brian Aker'], 3),
301 ('memcached_result_st', 'memcached_result_st', u'Working with result sets', [u'Brian Aker'], 3),
302 ('memcached_result_st', 'memcached_result_value', u'Working with result sets', [u'Brian Aker'], 3),
303 ('libmemcached/memcached_return_t', 'memcached_return_t', u'Return type values ', [u'Brian Aker'], 3),
304 ('memcached_sasl', 'memcached_destroy_sasl_auth_data', u'libmemcached Documentation', [u'Brian Aker'], 3),
305 ('memcached_sasl', 'memcached_get_sasl_callbacks', u'libmemcached Documentation', [u'Brian Aker'], 3),
306 ('memcached_sasl', 'memcached_sasl', u'libmemcached Documentation', [u'Brian Aker'], 3),
307 ('memcached_sasl', 'memcached_sasl_set_auth_data', u'libmemcached Documentation', [u'Brian Aker'], 3),
308 ('memcached_sasl', 'memcached_set_sasl_callbacks', u'libmemcached Documentation', [u'Brian Aker'], 3),
309 ('memcached_server_st', 'memcached_server_list_append', u'libmemcached Documentation', [u'Brian Aker'], 3),
310 ('memcached_server_st', 'memcached_server_list_count', u'libmemcached Documentation', [u'Brian Aker'], 3),
311 ('memcached_server_st', 'memcached_server_list_free', u'libmemcached Documentation', [u'Brian Aker'], 3),
312 ('memcached_server_st', 'memcached_servers_parse', u'libmemcached Documentation', [u'Brian Aker'], 3),
313 ('memcached_servers', 'memcached_server_add', u'libmemcached Documentation', [u'Brian Aker'], 3),
314 ('memcached_servers', 'memcached_server_add_unix_socket', u'libmemcached Documentation', [u'Brian Aker'], 3),
315 ('memcached_servers', 'memcached_server_count', u'libmemcached Documentation', [u'Brian Aker'], 3),
316 ('memcached_servers', 'memcached_server_cursor', u'libmemcached Documentation', [u'Brian Aker'], 3),
317 ('memcached_servers', 'memcached_server_list', u'libmemcached Documentation', [u'Brian Aker'], 3),
318 ('memcached_servers', 'memcached_server_push', u'libmemcached Documentation', [u'Brian Aker'], 3),
319 ('memcached_servers', 'memcached_server_st', u'libmemcached Documentation', [u'Brian Aker'], 3),
320 ('memcached_servers', 'memcached_servers', u'libmemcached Documentation', [u'Brian Aker'], 3),
321 ('memcached_set', 'memcached_add', u'Storing and Replacing Data', [u'Brian Aker'], 3),
322 ('memcached_set', 'memcached_add_by_key', u'Storing and Replacing Data', [u'Brian Aker'], 3),
323 ('memcached_set', 'memcached_replace', u'Storing and Replacing Data', [u'Brian Aker'], 3),
324 ('memcached_set', 'memcached_replace_by_key', u'Storing and Replacing Data', [u'Brian Aker'], 3),
325 ('memcached_set', 'memcached_set', u'Storing and Replacing Data', [u'Brian Aker'], 3),
326 ('memcached_set', 'memcached_set_by_key', u'Storing and Replacing Data', [u'Brian Aker'], 3),
327 ('memcached_stats', 'memcached_stat', u'libmemcached Documentation', [u'Brian Aker'], 3),
328 ('memcached_stats', 'memcached_stat_execute', u'libmemcached Documentation', [u'Brian Aker'], 3),
329 ('memcached_stats', 'memcached_stat_get_keys', u'libmemcached Documentation', [u'Brian Aker'], 3),
330 ('memcached_stats', 'memcached_stat_get_value', u'libmemcached Documentation', [u'Brian Aker'], 3),
331 ('memcached_stats', 'memcached_stat_servername', u'libmemcached Documentation', [u'Brian Aker'], 3),
332 ('memcached_stats', 'memcached_stats', u'libmemcached Documentation', [u'Brian Aker'], 3),
333 ('memcached_strerror', 'memcached_strerror', u'libmemcached Documentation', [u'Brian Aker'], 3),
334 ('memcached_user_data', 'memcached_get_user_data', u'libmemcached Documentation', [u'Brian Aker'], 3),
335 ('memcached_user_data', 'memcached_set_user_data', u'libmemcached Documentation', [u'Brian Aker'], 3),
336 ('memcached_user_data', 'memcached_user_data', u'libmemcached Documentation', [u'Brian Aker'], 3),
337 ('memcached_verbosity', 'memcached_verbosity', u'libmemcached Documentation', [u'Brian Aker'], 3),
338 ('memcached_version', 'memcached_lib_version', u'libmemcached Documentation', [u'Brian Aker'], 3),
339 ('memcached_version', 'memcached_version', u'libmemcached Documentation', [u'Brian Aker'], 3),
340 ('bin/memcapable', 'memcapable', u'libmemcached Documentation', [u'Brian Aker'], 1),
341 ('bin/memcat', 'memcat', u'libmemcached Documentation', [u'Brian Aker'], 1),
342 ('bin/memcp', 'memcp', u'libmemcached Documentation', [u'Brian Aker'], 1),
343 ('bin/memdump', 'memdump', u'libmemcached Documentation', [u'Brian Aker'], 1),
344 ('bin/memerror', 'memerror', u'libmemcached Documentation', [u'Brian Aker'], 1),
345 ('bin/memflush', 'memflush', u'libmemcached Documentation', [u'Brian Aker'], 1),
346 ('bin/memrm', 'memrm', u'libmemcached Documentation', [u'Brian Aker'], 1),
347 ('bin/memaslap', 'memaslap', u'libmemcached Documentation', [u'Brian Aker'], 1),
348 ('bin/memslap', 'memslap', u'libmemcached Documentation', [u'Brian Aker'], 1),
349 ('bin/memstat', 'memstat', u'libmemcached Documentation', [u'Brian Aker'], 1),
350 ]