Merge in more documentation.

[awesomized/libmemcached] / docs / conf.py

diff --git a/docs/conf.py b/docs/conf.py
index 2c6347079c1bab4b0af89b750087c6b8383c797a..33febd2e4e2f6e18d7f44929fbaec763f48a3e6e 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -227,15 +227,15 @@ man_pages = [
   ('hashkit_functions', 'hashkit_murmur', 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),
   ('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),
@@ -251,16 +251,17 @@ 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),
@@ -274,15 +275,15 @@ man_pages = [
   ('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),
@@ -300,18 +301,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),