X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Findex.rst;h=c3cca3bee690c39889c6e1257d6c02774df58134;hb=983523c4536f12781533124cb8a00a4291b8cf79;hp=b2228ea49c91d0ff767253402b2bd075e8855ac2;hpb=f285e1b3821f56a8983b5ce9fb1a0070e7bb0a1c;p=m6w6%2Flibmemcached diff --git a/docs/index.rst b/docs/index.rst index b2228ea4..c3cca3be 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,57 +1,155 @@ -.. libmemcached documentation master file, created by - sphinx-quickstart on Sun Mar 6 12:05:53 2011. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +========================================= +Welcome to the libmemcached documentation +========================================= -Welcome to libmemcached's documentation! -======================================== +------------ +Libmemcached +------------ + + +###### +Basics +###### -Contents: .. toctree:: - :maxdepth: 2 + :maxdepth: 1 - hashkit_create - hashkit_functions - hashkit_value - index - libmemcached_examples libmemcached - libmemcachedutil - memcached_analyze - memcached_auto - memcached_behavior - memcached_callback + versioning memcached_create + libmemcached_examples + libmemcached_configuration + libmemcached/memcached_last_error_message + +################# +Working with data +################# + +.. toctree:: + :maxdepth: 1 + + memcached_auto memcached_delete - memcached_dump + libmemcached/memcached_exist memcached_flush_buffers memcached_flush - memcached_generate_hash_value memcached_get + memcached_result_st + memcached_set + memcached_append + memcached_cas + + +############### +Advanced Topics +############### + +.. toctree:: + :maxdepth: 1 + + libmemcached-1.0/memcached_set_encoding_key + memcached_behavior + memcached_callback + memcached_dump + memcached_generate_hash_value memcached_memory_allocators - memcached_pool memcached_quit - memcached_result_st + libmemcached/memcached_return_t memcached_sasl - memcached_servers memcached_server_st - memcached_set - memcached_stats + memcached_servers memcached_strerror + error_messages memcached_user_data - memcached_verbosity - memcached_version - memcapable - memcat - memcp - memdump - memerror - memflush - memrm - memslap - memstat + memcached_verbosity + memcached_version + libmemcached/defaults +################## +Interface Versions +################## + +.. toctree:: + :titlesonly: + + libmemcached-1.0/index + libmemcached-1.1/index + +#################### +Deprecated Functions +#################### + +.. toctree:: + :titlesonly: + + libmemcached/memcached_fetch + +################# +Platform Specific +################# + +.. toctree:: + :maxdepth: 1 + + tap + types + +################################# +Deriving statistics from a server +################################# + +.. toctree:: + :maxdepth: 1 + + memcached_analyze + memcached_stats + +---------------- +Libmemcachedutil +---------------- + +.. toctree:: + :maxdepth: 1 + + libmemcachedutil + memcached_pool + +------------------- +Client Applications +------------------- + +.. toctree:: + :maxdepth: 1 + + bin/memcapable + bin/memcat + bin/memcp + bin/memdump + bin/memerror + bin/memflush + bin/memrm + bin/memslap + bin/memaslap + bin/memstat + bin/memexist.rst + bin/memparse.rst + bin/memping.rst + bin/memtouch.rst + +---------- +Libhashkit +---------- + +.. toctree:: + :maxdepth: 1 + + libhashkit + hashkit_create + hashkit_functions + hashkit_value + +================== Indices and tables ==================