X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Findex.rst;h=57e2671d766012920dda43fe3e2c75cad2845f74;hb=609d07c5a051c301ce6595747c2f64d3819554f5;hp=8987eaef21349abea54ac778fad80525991c32e1;hpb=053275c87dbc91f5134840980f6d9902b8a12257;p=m6w6%2Flibmemcached diff --git a/docs/index.rst b/docs/index.rst index 8987eaef..57e2671d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,16 +1,137 @@ -.. 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 +------------ -Contents: + +###### +Basics +###### + + +.. toctree:: + :maxdepth: 1 + + libmemcached + memcached_create + libmemcached_examples + libmemcached_configuration + error_messages + + +################# +Working with data +################# + +.. toctree:: + :maxdepth: 1 + + memcached_auto + memcached_delete + memcached_flush_buffers + memcached_flush + memcached_get + memcached_result_st + memcached_set + memcached_append + memcached_cas + + +############### +Advanced Topics +############### + +.. toctree:: + :maxdepth: 1 + + memcached_behavior + memcached_callback + memcached_dump + memcached_generate_hash_value + memcached_memory_allocators + memcached_quit + libmemcached/memcached_return_t + memcached_sasl + memcached_server_st + memcached_servers + memcached_strerror + memcached_user_data + memcached_verbosity + memcached_version + + +#################### +Deprecated Functions +#################### .. toctree:: - :maxdepth: 2 + :titlesonly: + + libmemcached/memcached_fetch +################# +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 + + bin/memcapable + bin/memcat + bin/memcp + bin/memdump + bin/memerror + bin/memflush + bin/memrm + bin/memslap + bin/memaslap + bin/memstat + +---------- +Libhashkit +---------- + +.. toctree:: + :maxdepth: 1 + + libhashkit + hashkit_create + hashkit_functions + hashkit_value + +================== Indices and tables ==================