Mirroristas/bigchaindb
2
0
Fork 0
mirror of https://github.com/bigchaindb/bigchaindb.git synced 2024-10-13 13:34:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Make the autodoc members option the default

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/server/source/appendices/consensus.rst
View File

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

5
docs/server/source/appendices/pipelines.rst
View File

@ -6,32 +6,27 @@ Block Creation
============== ==============
.. automodule:: bigchaindb.pipelines.block .. automodule:: bigchaindb.pipelines.block
:members:
Block Voting Block Voting
============ ============
.. automodule:: bigchaindb.pipelines.vote .. automodule:: bigchaindb.pipelines.vote
:members:
Block Status Block Status
============ ============
.. automodule:: bigchaindb.pipelines.election .. automodule:: bigchaindb.pipelines.election
:members:
Stale Transaction Monitoring Stale Transaction Monitoring
============================ ============================
.. automodule:: bigchaindb.pipelines.stale .. automodule:: bigchaindb.pipelines.stale
:members:
Utilities Utilities
========= =========
.. automodule:: bigchaindb.pipelines.utils .. automodule:: bigchaindb.pipelines.utils
:members:

1
docs/server/source/appendices/the-Bigchain-class.rst
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. 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 .. autoclass:: bigchaindb.Bigchain
:members:
.. automethod:: bigchaindb.core.Bigchain.__init__ .. automethod:: bigchaindb.core.Bigchain.__init__

3
docs/server/source/conf.py
View File

@ -56,6 +56,9 @@ extensions = [
# autodoc settings # autodoc settings
autodoc_member_order = 'bysource' autodoc_member_order = 'bysource'
autodoc_default_flags = [
'members',
]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']