Initial commit of docs

This commit is contained in:
Jason Paryani
2013-08-18 21:49:12 -07:00
parent 8b92a251e4
commit 22b3199335
7 changed files with 822 additions and 0 deletions

28
docs/index.rst Normal file
View File

@@ -0,0 +1,28 @@
.. capnp documentation master file
Welcome to capnp's documentation!
=================================
This is a python wrapping of the C++ implementation of the `Capnproto <http://kentonv.github.io/capnproto/>`_ library. Here is a description, quoted from its docs:
Capn Proto is an insanely fast data interchange format and capability-based RPC system. Think JSON, except binary. Or think Protocol Buffers, except faster. In fact, in benchmarks, Capn Proto is INFINITY TIMES faster than Protocol Buffers.
The INFINITY TIMES faster part isn't so true for python, but in some simplistic benchmarks (available in the `benchmark directory of the repo <https://github.com/jparyani/capnpc-python-cpp/tree/master/benchmark>`_), capnp is 4x faster than the pure python Protocol Buffer library, and 2x faster than the C++ implementation.
Contents:
.. toctree::
:maxdepth: 4
install
quickstart
capnp
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`