docs: sanitize
[awesomized/libmemcached] / docs / source / libhashkit.rst
index 5e6e28a5ba84fc70e27532d5c7af6957aa6d64b2..e23c92482733aad9f8f2ae732740aa56743aa764 100644 (file)
@@ -1,28 +1,36 @@
-======================
-Introducing libhashkit
-======================
-
-
-.. code-block:: c
-
-   cc [ flag ... ] file ... -lhashkit
-   #include <libhashkit/hashkit.h>
+libhashkit - C/C++ hashing library
+==================================
 
+SYNOPSIS
+--------
 
+#include <libhashkit-|libhashkit_version|/hashkit.h>
+  Compile and link with -lhashkit.
 
------------
 DESCRIPTION
 -----------
 
+`libhashkit` is a small and thread-safe client library that provides a collection
+of useful hashing algorithm.
 
-libhashkit  is a small and thread-safe client library that provides a collection of useful hashing algorithm. libhashkit is distributed with libmemcached.
-
+`libhashkit` is distributed with `libmemcached`.
 
-
---------
 SEE ALSO
 --------
 
-:manpage:`libhashkit(3)`
+.. only:: man
+
+    :manpage:`libmemcached(3)`
+    :manpage:`hashkit_create(3)`
+    :manpage:`hashkit_function(3)`
+    :manpage:`hashkit_functions(3)`
+    :manpage:`hashkit_value(3)`
+
+.. only:: html
+
+    * :doc:`libmemcached`
+    * :doc:`libhashkit/hashkit_create`
+    * :doc:`libhashkit/hashkit_function`
+    * :doc:`libhashkit/hashkit_functions`
+    * :doc:`libhashkit/hashkit_value`