From 6c3041a9c682c04006af301fb152baeb60df2460 Mon Sep 17 00:00:00 2001
From: Jason Paryani <github@jparyani.com>
Date: Sun, 18 Aug 2013 22:43:40 -0700
Subject: [PATCH] Fix up docs

---
 docs/capnp.rst      | 31 +++++++++++++++++++++++++++++++
 docs/quickstart.rst | 10 +++++-----
 2 files changed, 36 insertions(+), 5 deletions(-)

diff --git a/docs/capnp.rst b/docs/capnp.rst
index a772f03..44b606d 100644
--- a/docs/capnp.rst
+++ b/docs/capnp.rst
@@ -2,3 +2,34 @@
 
 API Reference
 ===================
+
+.. automodule:: capnp
+
+.. currentmodule:: capnp
+
+Functions
+-------------
+.. autofunction:: load
+.. autofunction:: writeMessageToFd
+.. autofunction:: writePackedMessageToFd
+
+Readers
+-------------
+
+.. autoclass:: StreamFdMessageReader
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: PackedFdMessageReader
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+Writers
+-------------
+
+.. autoclass:: MallocMessageBuilder
+  :members:
+  :undoc-members:
+  :inherited-members:
diff --git a/docs/quickstart.rst b/docs/quickstart.rst
index dc97d5a..eb59a88 100644
--- a/docs/quickstart.rst
+++ b/docs/quickstart.rst
@@ -8,7 +8,7 @@ This assumes you already have the capnp library installed. If you don't, please
 In general, this library is a very light wrapping of the `Capnproto C++ library <http://kentonv.github.io/capnproto/cxx.html>`_. You can refer to its docs for more advanced concepts, or just to get a basic idea of how the python library is structured.
 
 Load a Capnproto Schema
--------------
+------------------------
 
 First you need to import the library::
     
@@ -54,7 +54,7 @@ For future reference, here is the capnproto schema. Also available in the github
     }
 
 Build a message
--------------
+------------------
 
 Message Builder
 ~~~~~~~~~~~~~~~~~~~
@@ -64,7 +64,7 @@ First you need to allocate a MessageBuilder for your message to go in. There is
     message = capnp.MallocMessageBuilder()
 
 Initialize a New Capnproto Object
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Now that you have a message buffer, you need to allocate an actual object that is from your schema. In this case, we will allocate an `AddressBook`::
 
@@ -143,7 +143,7 @@ For now, the only way to serialize a message is to write it directly to a file d
 Note the call to fileno(), since it expects a raw file descriptor. There is also `writeMessageToFd` instead of `writePackedMessageToFd`. Make sure your reader uses the same packing type.
 
 Read a message
--------------
+-----------------
 
 Reading from a file
 ~~~~~~~~~~~~~~~~~~~~~~
@@ -154,7 +154,7 @@ Much like before, you will have to de-serialize the message from a file descript
     message = capnp.PackedFdMessageReader(f.fileno())
 
 Initialize a New Capnproto Object
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Just like when building, you have to actually specify which message you want to read out of buffer::