Initial commit of docs

2013-08-18 21:49:12 -07:00
parent 8b92a251e4
commit 22b3199335
7 changed files with 822 additions and 0 deletions
--- a/docs/capnp.rst
+++ b/docs/capnp.rst
@@ -0,0 +1,35 @@
+.. _api:
+
+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: