Problem: There are no docs for the tendermint integration API

Solution: Add docs for the tendermint integration in Appendices for now.
This commit is contained in:
Sylvain Bellemare 2017-12-24 08:27:37 +01:00
parent c2e9dd6e1c
commit 12f603b8d2
4 changed files with 32 additions and 0 deletions

View File

@ -1,3 +1,5 @@
"""Code necessary for integrating with Tendermint."""
# Order is important! # Order is important!
# If we import core first, core will try to load BigchainDB from # If we import core first, core will try to load BigchainDB from
# __init__ itself, causing a loop. # __init__ itself, causing a loop.

View File

@ -1,3 +1,7 @@
"""Module containing main contact points with Tendermint and
MongoDB.
"""
import logging import logging
from collections import namedtuple from collections import namedtuple
from copy import deepcopy from copy import deepcopy

View File

@ -11,6 +11,7 @@ Appendices
the-Bigchain-class the-Bigchain-class
backend backend
commands commands
tendermint-integration
aws-setup aws-setup
generate-key-pair-for-ssh generate-key-pair-for-ssh
firewall-notes firewall-notes

View File

@ -0,0 +1,25 @@
######################
Tendermint Integration
######################
.. automodule:: bigchaindb.tendermint
:special-members: __init__
.. automodule:: bigchaindb.tendermint.lib
:special-members: __init__
.. automodule:: bigchaindb.tendermint.core
:special-members: __init__
.. automodule:: bigchaindb.tendermint.event_stream
:special-members: __init__
.. automodule:: bigchaindb.tendermint.fastquery
:special-members: __init__
.. automodule:: bigchaindb.tendermint.commands
:special-members: __init__
.. automodule:: bigchaindb.tendermint.utils
:special-members: __init__