mirror of
https://github.com/bigchaindb/bigchaindb.git
synced 2024-10-13 13:34:05 +00:00
Make the autodoc members option the default
This commit is contained in:
parent
44d1bb2c97
commit
7940479ee3
@ -3,4 +3,3 @@ Consensus
|
||||
#########
|
||||
|
||||
.. automodule:: bigchaindb.consensus
|
||||
:members:
|
||||
|
@ -6,32 +6,27 @@ Block Creation
|
||||
==============
|
||||
|
||||
.. automodule:: bigchaindb.pipelines.block
|
||||
:members:
|
||||
|
||||
|
||||
Block Voting
|
||||
============
|
||||
|
||||
.. automodule:: bigchaindb.pipelines.vote
|
||||
:members:
|
||||
|
||||
|
||||
Block Status
|
||||
============
|
||||
|
||||
.. automodule:: bigchaindb.pipelines.election
|
||||
:members:
|
||||
|
||||
|
||||
Stale Transaction Monitoring
|
||||
============================
|
||||
|
||||
.. automodule:: bigchaindb.pipelines.stale
|
||||
:members:
|
||||
|
||||
|
||||
Utilities
|
||||
=========
|
||||
|
||||
.. automodule:: bigchaindb.pipelines.utils
|
||||
:members:
|
||||
|
@ -5,6 +5,5 @@ The Bigchain class
|
||||
The Bigchain class is the top-level Python API for BigchainDB. If you want to create and initialize a BigchainDB database, you create a Bigchain instance (object). Then you can use its various methods to create transactions, write transactions (to the object/database), read transactions, etc.
|
||||
|
||||
.. autoclass:: bigchaindb.Bigchain
|
||||
:members:
|
||||
|
||||
.. automethod:: bigchaindb.core.Bigchain.__init__
|
||||
|
@ -56,6 +56,9 @@ extensions = [
|
||||
|
||||
# autodoc settings
|
||||
autodoc_member_order = 'bysource'
|
||||
autodoc_default_flags = [
|
||||
'members',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
Loading…
x
Reference in New Issue
Block a user