docs: m2r BUGS.md issues.rst
[awesomized/libmemcached] / docs / source / index.rst
index c3cca3bee690c39889c6e1257d6c02774df58134..a870db40279394287ee46ca06d47e302d2d12410 100644 (file)
-=========================================
-Welcome to the libmemcached documentation
-=========================================
+libmemcached-awesome Manual
+===========================
 
-------------
-Libmemcached
-------------
+``libmemcached-awesome`` is an open source C/C++ client library and tools for the
+memcached server (http://memcached.org/). It has been designed to be light on
+memory usage, thread safe, and provide full access to server side methods.
 
 
-######
-Basics
-######
-
-
-.. toctree::
-   :maxdepth: 1
-
-   libmemcached
-   versioning
-   memcached_create
-   libmemcached_examples
-   libmemcached_configuration
-   libmemcached/memcached_last_error_message
-
-#################
-Working with data
-#################
-
 .. toctree::
-   :maxdepth: 1
-
-   memcached_auto
-   memcached_delete
-   libmemcached/memcached_exist
-   memcached_flush_buffers
-   memcached_flush
-   memcached_get
-   memcached_result_st
-   memcached_set
-   memcached_append
-   memcached_cas
-
+    :titlesonly:
 
-###############
-Advanced Topics
-###############
+    Introduction <libmemcached>
+    libmemcached/index
+    libmemcachedutil API <libmemcachedutil/index>
+    libhashkit API <libhashkit/index>
+    bin/index
+    libmemcached/index_misc
 
 .. toctree::
-   :maxdepth: 1
-
-   libmemcached-1.0/memcached_set_encoding_key
-   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
-   error_messages
-   memcached_user_data
-   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
+    :maxdepth: 1
 
-==================
-Indices and tables
-==================
+    changelogs
+    Known issues <issues>
+    copyright
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+Index
+-----
 
+:ref:`genindex`