X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Findex.rst;h=d9d3e033008a527e700490e3e2743dfe9bf7f2e5;hb=088eed04d829b8cf6591201564118c356d3cf935;hp=8db8ebbd81b9801d3745b675367dd3575a0027a4;hpb=1edb76c1dfdf6307d010307b6f04bed3ce22e3a2;p=awesomized%2Flibmemcached diff --git a/docs/index.rst b/docs/index.rst index 8db8ebbd..d9d3e033 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,46 +1,100 @@ -.. 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 - libmemcached_examples libmemcached - libmemcachedutil - memcached_analyze - memcached_auto - memcached_behavior - memcached_callback memcached_create + libmemcached_examples + libmemcached_configuration + error_messages + + +################# +Working with data +################# + +.. toctree:: + :maxdepth: 1 + + memcached_auto memcached_delete - memcached_dump memcached_flush_buffers memcached_flush - memcached_generate_hash_value memcached_get + memcached_result_st + memcached_set + + +############### +Advanced Topics +############### + +.. toctree:: + :maxdepth: 1 + + memcached_behavior + memcached_callback + memcached_dump + memcached_generate_hash_value memcached_memory_allocators - memcached_pool memcached_quit - memcached_result_st memcached_sasl - memcached_servers memcached_server_st - memcached_set - memcached_stats + memcached_servers memcached_strerror memcached_user_data memcached_verbosity memcached_version + +################# +Platform Specific +################# + +.. toctree:: + :maxdepth: 1 + + tap + +################################# +Deriving statistics from a server +################################# + +.. toctree:: + :maxdepth: 1 + + memcached_analyze + memcached_stats + +---------------- +Libmemcachedutil +---------------- + +.. toctree:: + :maxdepth: 1 + + libmemcachedutil + memcached_pool + +------------------- +Client Applications +------------------- + +.. toctree:: + :maxdepth: 1 + memcapable memcat memcp @@ -49,8 +103,22 @@ Contents: memflush memrm memslap + memaslap memstat +---------- +Libhashkit +---------- + +.. toctree:: + :maxdepth: 1 + + libhashkit + hashkit_create + hashkit_functions + hashkit_value + +================== Indices and tables ==================