From 12f603b8d28d4dc0d18dd68c145ea5505a6b7235 Mon Sep 17 00:00:00 2001 From: Sylvain Bellemare Date: Sun, 24 Dec 2017 08:27:37 +0100 Subject: [PATCH] Problem: There are no docs for the tendermint integration API Solution: Add docs for the tendermint integration in Appendices for now. --- bigchaindb/tendermint/__init__.py | 2 ++ bigchaindb/tendermint/lib.py | 4 +++ docs/server/source/appendices/index.rst | 1 + .../appendices/tendermint-integration.rst | 25 +++++++++++++++++++ 4 files changed, 32 insertions(+) create mode 100644 docs/server/source/appendices/tendermint-integration.rst diff --git a/bigchaindb/tendermint/__init__.py b/bigchaindb/tendermint/__init__.py index f3bb13ad..b98dd439 100644 --- a/bigchaindb/tendermint/__init__.py +++ b/bigchaindb/tendermint/__init__.py @@ -1,3 +1,5 @@ +"""Code necessary for integrating with Tendermint.""" + # Order is important! # If we import core first, core will try to load BigchainDB from # __init__ itself, causing a loop. diff --git a/bigchaindb/tendermint/lib.py b/bigchaindb/tendermint/lib.py index 88f65ddd..a201e862 100644 --- a/bigchaindb/tendermint/lib.py +++ b/bigchaindb/tendermint/lib.py @@ -1,3 +1,7 @@ +"""Module containing main contact points with Tendermint and +MongoDB. + +""" import logging from collections import namedtuple from copy import deepcopy diff --git a/docs/server/source/appendices/index.rst b/docs/server/source/appendices/index.rst index db1695b5..ab37aae0 100755 --- a/docs/server/source/appendices/index.rst +++ b/docs/server/source/appendices/index.rst @@ -11,6 +11,7 @@ Appendices the-Bigchain-class backend commands + tendermint-integration aws-setup generate-key-pair-for-ssh firewall-notes diff --git a/docs/server/source/appendices/tendermint-integration.rst b/docs/server/source/appendices/tendermint-integration.rst new file mode 100644 index 00000000..175cbe80 --- /dev/null +++ b/docs/server/source/appendices/tendermint-integration.rst @@ -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__