KBDocs3
[m6w6/libmemcached] / docs / index.rst
index 4b115cdfc15a67e1dabc051fa470144df81d8e50..cef0830dbd9e078b84a9ea59c5bd031ff4e1b584 100644 (file)
-========================================
-Welcome to libmemcached's documentation!
-========================================
+=========================================
+Welcome to the libmemcached documentation
+=========================================
 
 ------------
 Libmemcached
 ------------
 
+
+######
+Basics
+######
+
+
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
    libmemcached
+   memcached_create
    libmemcached_examples
-   libmemcachedutil
-   memcached_analyze
+   libmemcached_configuration
+   error_messages
+
+
+#################
+Working with data
+#################
+
+.. toctree::
+   :maxdepth: 1
+
    memcached_auto
-   memcached_behavior
-   memcached_callback
-   memcached_create
    memcached_delete
-   memcached_dump
    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
+
+   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
@@ -44,6 +105,7 @@ Libmemcached
    memflush
    memrm
    memslap
+   memaslap
    memstat
 
 ----------
@@ -51,12 +113,14 @@ Libhashkit
 ----------
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
+   libhashkit
    hashkit_create
    hashkit_functions
    hashkit_value
 
+==================
 Indices and tables
 ==================