Add docs for backend

This commit is contained in:
Sylvain Bellemare
2016-12-05 15:25:27 +01:00
parent 67af0deaae
commit d43e77ce4a
5 changed files with 80 additions and 1 deletions

View File

@@ -0,0 +1,61 @@
###############################################
:mod:`bigchaindb.backend` -- Backend Interfaces
###############################################
.. automodule:: bigchaindb.backend
:special-members: __init__
Generic Backend
===============
:mod:`bigchaindb.backend.connection` -- Connection
--------------------------------------------------
.. automodule:: bigchaindb.backend.connection
:mod:`bigchaindb.backend.schema` -- Schema
------------------------------------------
.. automodule:: bigchaindb.backend.schema
:mod:`bigchaindb.backend.query` -- Query
----------------------------------------
.. automodule:: bigchaindb.backend.query
:mod:`bigchaindb.backend.changefeed` -- Changefeed
--------------------------------------------------
.. automodule:: bigchaindb.backend.changefeed
:mod:`bigchaindb.backend.utils`
-------------------------------
.. automodule:: bigchaindb.backend.utils
:mod:`bigchaindb.backend.rethinkdb` -- RethinkDB Backend
========================================================
.. automodule:: bigchaindb.backend.rethinkdb
:special-members: __init__
:mod:`bigchaindb.backend.rethinkdb.connection`
----------------------------------------------
.. automodule:: bigchaindb.backend.rethinkdb.connection
:special-members: __init__
:mod:`bigchaindb.backend.rethinkdb.schema`
------------------------------------------
.. automodule:: bigchaindb.backend.rethinkdb.schema
:mod:`bigchaindb.backend.rethinkdb.query`
-----------------------------------------
.. automodule:: bigchaindb.backend.rethinkdb.query
:mod:`bigchaindb.backend.rethinkdb.changefeed`
----------------------------------------------
.. automodule:: bigchaindb.backend.rethinkdb.changefeed
MongoDB Backend
===============
Stay tuned!

View File

@@ -15,6 +15,7 @@ Appendices
the-Bigchain-class
consensus
pipelines
backend
aws-setup
firewall-notes
ntp-notes