Make the autodoc members option the default

This commit is contained in:
Sylvain Bellemare 2016-12-05 17:39:26 +01:00 committed by Sylvain Bellemare
parent 44d1bb2c97
commit 7940479ee3
4 changed files with 3 additions and 7 deletions

View File

@ -3,4 +3,3 @@ Consensus
#########
.. automodule:: bigchaindb.consensus
:members:

View File

@ -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:

View File

@ -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__

View File

@ -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']