Merge in additional documentation updates.
[m6w6/libmemcached] / docs / conf.py
index c13fee6305dd941afd2b8a00dbcb1bb16e019024..47025e4b318cc68de654f8fe1ecffa2838bb2815 100644 (file)
@@ -41,7 +41,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'libmemcached'
-copyright = u'2011, Brian Aker'
+copyright = u'2011, Brian Aker DataDifferential, http://datadifferential.com/'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -211,6 +211,7 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
+  ('libhashkit', 'libhashkit', u'libhashkit Documentation', [u'Brian Aker'], 3),
   ('hashkit_create', 'hashkit_clone', u'libhashkit Documentation', [u'Brian Aker'], 3),
   ('hashkit_create', 'hashkit_create', u'libhashkit Documentation', [u'Brian Aker'], 3),
   ('hashkit_create', 'hashkit_free', u'libhashkit Documentation', [u'Brian Aker'], 3),
@@ -224,17 +225,20 @@ man_pages = [
   ('hashkit_functions', 'hashkit_jenkins', u'libhashkit Documentation', [u'Brian Aker'], 3),
   ('hashkit_functions', 'hashkit_md5', u'libhashkit Documentation', [u'Brian Aker'], 3),
   ('hashkit_functions', 'hashkit_murmur', u'libhashkit Documentation', [u'Brian Aker'], 3),
-  ('hashkit_hsieh', 'hashkit_hsieh', u'libhashkit Documentation', [u'Brian Aker'], 3),
+  ('hashkit_functions', 'hashkit_hsieh', u'libhashkit Documentation', [u'Brian Aker'], 3),
   ('hashkit_value', 'hashkit_value', u'libhashkit Documentation', [u'Brian Aker'], 3),
-  ('libmemcached', 'libmemcached', u'libmemcached Documentation', [u'Brian Aker'], 3),
+  ('libmemcached', 'libmemcached', u'Introducing the C Client Library for memcached', [u'Brian Aker'], 3),
   ('libmemcached_examples', 'libmemcached_examples', u'libmemcached Documentation', [u'Brian Aker'], 3),
+  ('libmemcached_configuration', 'libmemcached_configuration', u'libmemcached Documentation', [u'Brian Aker'], 3),
+  ('libmemcached_configuration', 'memcached_create_with_options', u'libmemcached Documentation', [u'Brian Aker'], 3),
+  ('libmemcached_configuration', 'libmemcached_check_configuration', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('libmemcachedutil', 'libmemcachedutil', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('memcached_analyze', 'memcached_analyze', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_auto', 'memcached_auto', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_auto', 'memcached_decrement', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_auto', 'memcached_decrement_with_initial', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_auto', 'memcached_increment', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_auto', 'memcached_increment_with_initial', u'libmemcached Documentation', [u'Brian Aker'], 3),
+  ('memcached_auto', 'memcached_auto', u'Incrementing and Decrementing Values', [u'Brian Aker'], 3),
+  ('memcached_auto', 'memcached_decrement', u'Incrementing and Decrementing Values', [u'Brian Aker'], 3),
+  ('memcached_auto', 'memcached_decrement_with_initial', u'Incrementing and Decrementing Values', [u'Brian Aker'], 3),
+  ('memcached_auto', 'memcached_increment', u'Incrementing and Decrementing Values', [u'Brian Aker'], 3),
+  ('memcached_auto', 'memcached_increment_with_initial', u'Incrementing and Decrementing Values', [u'Brian Aker'], 3),
   ('memcached_behavior', 'memcached_behavior', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('memcached_behavior', 'memcached_behavior_get', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('memcached_behavior', 'memcached_behavior_set', u'libmemcached Documentation', [u'Brian Aker'], 3),
@@ -250,37 +254,40 @@ man_pages = [
   ('memcached_dump', 'memcached_dump', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('memcached_flush', 'memcached_flush', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('memcached_flush_buffers', 'memcached_flush_buffers', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_generate_hash_value', 'memcached_generate_hash_value', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_get', 'memcached_fetch', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_get', 'memcached_fetch_execute', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_get', 'memcached_fetch_result', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_get', 'memcached_get', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_get', 'memcached_get_by_key', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_get', 'memcached_mget', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_get', 'memcached_mget_by_key', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_get', 'memcached_mget_execute', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_get', 'memcached_mget_execute_by_key', u'libmemcached Documentation', [u'Brian Aker'], 3),
+  ('memcached_generate_hash_value', 'memcached_generate_hash_value', u'Generating hash values directly', [u'Brian Aker'], 3),
+  ('memcached_generate_hash_value', 'memcached_generate_hash', u'Generating hash values directly', [u'Brian Aker'], 3),
+  ('memcached_get', 'memcached_fetch', u'Retrieving data from the server', [u'Brian Aker'], 3),
+  ('memcached_get', 'memcached_fetch_execute', u'Retrieving data from the server', [u'Brian Aker'], 3),
+  ('memcached_get', 'memcached_fetch_result', u'Retrieving data from the server', [u'Brian Aker'], 3),
+  ('memcached_get', 'memcached_get', u'Retrieving data from the server', [u'Brian Aker'], 3),
+  ('memcached_get', 'memcached_get_by_key', u'Retrieving data from the server', [u'Brian Aker'], 3),
+  ('memcached_get', 'memcached_mget', u'Retrieving data from the server', [u'Brian Aker'], 3),
+  ('memcached_get', 'memcached_mget_by_key', u'Retrieving data from the server', [u'Brian Aker'], 3),
+  ('memcached_get', 'memcached_mget_execute', u'Retrieving data from the server', [u'Brian Aker'], 3),
+  ('memcached_get', 'memcached_mget_execute_by_key', u'Retrieving data from the server', [u'Brian Aker'], 3),
   ('memcached_memory_allocators', 'memcached_get_memory_allocators', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('memcached_memory_allocators', 'memcached_memory_allocators', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('memcached_memory_allocators', 'memcached_set_memory_allocators', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('memcached_memory_allocators', 'memcached_set_memory_allocators_context', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('memcached_pool', 'memcached_pool', u'libmemcached Documentation', [u'Brian Aker'], 3),
+  ('memcached_pool', 'memcached_pool_st', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('memcached_pool', 'memcached_pool_behavior_get', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('memcached_pool', 'memcached_pool_behavior_set', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('memcached_pool', 'memcached_pool_create', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('memcached_pool', 'memcached_pool_destroy', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('memcached_pool', 'memcached_pool_push', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_pool', 'memcached_pool_rst', u'libmemcached Documentation', [u'Brian Aker'], 3),
+  ('memcached_pool', 'memcached_pool_pop', u'libmemcached Documentation', [u'Brian Aker'], 3),
+  ('memcached_pool', 'memcached_pool_push', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('memcached_quit', 'memcached_quit', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_result_st', 'memcached_result_cas', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_result_st', 'memcached_result_create', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_result_st', 'memcached_result_flags', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_result_st', 'memcached_result_free', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_result_st', 'memcached_result_key_length', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_result_st', 'memcached_result_key_value', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_result_st', 'memcached_result_length', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_result_st', 'memcached_result_st', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_result_st', 'memcached_result_value', u'libmemcached Documentation', [u'Brian Aker'], 3),
+  ('memcached_result_st', 'memcached_result_cas', u'Working with result sets', [u'Brian Aker'], 3),
+  ('memcached_result_st', 'memcached_result_create', u'Working with result sets', [u'Brian Aker'], 3),
+  ('memcached_result_st', 'memcached_result_flags', u'Working with result sets', [u'Brian Aker'], 3),
+  ('memcached_result_st', 'memcached_result_free', u'Working with result sets', [u'Brian Aker'], 3),
+  ('memcached_result_st', 'memcached_result_key_length', u'Working with result sets', [u'Brian Aker'], 3),
+  ('memcached_result_st', 'memcached_result_key_value', u'Working with result sets', [u'Brian Aker'], 3),
+  ('memcached_result_st', 'memcached_result_length', u'Working with result sets', [u'Brian Aker'], 3),
+  ('memcached_result_st', 'memcached_result_st', u'Working with result sets', [u'Brian Aker'], 3),
+  ('memcached_result_st', 'memcached_result_value', u'Working with result sets', [u'Brian Aker'], 3),
   ('memcached_sasl', 'memcached_destroy_sasl_auth_data', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('memcached_sasl', 'memcached_get_sasl_callbacks', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('memcached_sasl', 'memcached_sasl', u'libmemcached Documentation', [u'Brian Aker'], 3),
@@ -298,18 +305,18 @@ man_pages = [
   ('memcached_servers', 'memcached_server_push', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('memcached_servers', 'memcached_server_st', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('memcached_servers', 'memcached_servers', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_set', 'memcached_add', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_set', 'memcached_add_by_key', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_set', 'memcached_append', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_set', 'memcached_append_by_key', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_set', 'memcached_cas', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_set', 'memcached_cas_by_key', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_set', 'memcached_prepend', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_set', 'memcached_prepend_by_key', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_set', 'memcached_replace', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_set', 'memcached_replace_by_key', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_set', 'memcached_set', u'libmemcached Documentation', [u'Brian Aker'], 3),
-  ('memcached_set', 'memcached_set_by_key', u'libmemcached Documentation', [u'Brian Aker'], 3),
+  ('memcached_set', 'memcached_add', u'Storing and Replacing Data', [u'Brian Aker'], 3),
+  ('memcached_set', 'memcached_add_by_key', u'Storing and Replacing Data', [u'Brian Aker'], 3),
+  ('memcached_set', 'memcached_append', u'Storing and Replacing Data', [u'Brian Aker'], 3),
+  ('memcached_set', 'memcached_append_by_key', u'Storing and Replacing Data', [u'Brian Aker'], 3),
+  ('memcached_set', 'memcached_cas', u'Storing and Replacing Data', [u'Brian Aker'], 3),
+  ('memcached_set', 'memcached_cas_by_key', u'Storing and Replacing Data', [u'Brian Aker'], 3),
+  ('memcached_set', 'memcached_prepend', u'Storing and Replacing Data', [u'Brian Aker'], 3),
+  ('memcached_set', 'memcached_prepend_by_key', u'Storing and Replacing Data', [u'Brian Aker'], 3),
+  ('memcached_set', 'memcached_replace', u'Storing and Replacing Data', [u'Brian Aker'], 3),
+  ('memcached_set', 'memcached_replace_by_key', u'Storing and Replacing Data', [u'Brian Aker'], 3),
+  ('memcached_set', 'memcached_set', u'Storing and Replacing Data', [u'Brian Aker'], 3),
+  ('memcached_set', 'memcached_set_by_key', u'Storing and Replacing Data', [u'Brian Aker'], 3),
   ('memcached_stats', 'memcached_stat', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('memcached_stats', 'memcached_stat_execute', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('memcached_stats', 'memcached_stat_get_keys', u'libmemcached Documentation', [u'Brian Aker'], 3),
@@ -333,6 +340,7 @@ man_pages = [
   ('memcp', 'memcp', u'libmemcached Documentation', [u'Brian Aker'], 1),
   ('memdump', 'memdump', u'libmemcached Documentation', [u'Brian Aker'], 1),
   ('memerror', 'memerror', u'libmemcached Documentation', [u'Brian Aker'], 1),
+  ('memaslap', 'memaslap', u'libmemcached Documentation', [u'Brian Aker'], 1),
   ('memflush', 'memflush', u'libmemcached Documentation', [u'Brian Aker'], 1),
   ('memrm', 'memrm', u'libmemcached Documentation', [u'Brian Aker'], 1),
   ('memslap', 'memslap', u'libmemcached Documentation', [u'Brian Aker'], 1),