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

Problem: Code Reference docs hidden in appendices (#2473)

Browse Source 
Solution: Move the Code Reference docs into their own section
This commit is contained in:
Troy McConaghy
2018-09-04 12:17:27 +02:00
committed by GitHub
parent 230a5b2d69
commit f8bb29535a
6 changed files with 25 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
docs/server/source/appendices/backend.rst
View File

@@ -1,52 +0,0 @@
.. Copyright BigchainDB GmbH and BigchainDB contributors
SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)
Code is Apache-2.0 and docs are CC-BY-4.0
###########################
Database Backend Interfaces
###########################
.. automodule:: bigchaindb.backend
:special-members: __init__
Generic Interfaces
==================
:mod:`bigchaindb.backend.connection`
------------------------------------
.. automodule:: bigchaindb.backend.connection
:special-members: __init__
:mod:`bigchaindb.backend.query`
-------------------------------
.. automodule:: bigchaindb.backend.query
:mod:`bigchaindb.backend.schema`
--------------------------------
.. automodule:: bigchaindb.backend.schema
:mod:`bigchaindb.backend.utils`
-------------------------------
.. automodule:: bigchaindb.backend.utils
MongoDB Backend
===============
.. automodule:: bigchaindb.backend.localmongodb
:special-members: __init__
:mod:`bigchaindb.backend.localmongodb.connection`
-------------------------------------------------
.. automodule:: bigchaindb.backend.localmongodb.connection
:mod:`bigchaindb.backend.localmongodb.query`
--------------------------------------------
.. automodule:: bigchaindb.backend.localmongodb.query
:mod:`bigchaindb.backend.localmongodb.schema`
---------------------------------------------
.. automodule:: bigchaindb.backend.localmongodb.schema

23
docs/server/source/appendices/commands.rst
View File

@@ -1,23 +0,0 @@
.. Copyright BigchainDB GmbH and BigchainDB contributors
SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)
Code is Apache-2.0 and docs are CC-BY-4.0
######################
Command Line Interface
######################
.. automodule:: bigchaindb.commands
:special-members: __init__
:mod:`bigchaindb.commands.bigchaindb`
-------------------------------------
.. automodule:: bigchaindb.commands.bigchaindb
:mod:`bigchaindb.commands.utils`
--------------------------------
.. automodule:: bigchaindb.commands.utils

3
docs/server/source/appendices/index.rst
View File

@@ -11,9 +11,6 @@ Appendices
json-serialization
cryptography
the-bigchaindb-class
backend
commands
aws-setup
generate-key-pair-for-ssh
firewall-notes

10
docs/server/source/appendices/the-bigchaindb-class.rst
View File

@@ -1,10 +0,0 @@
.. Copyright BigchainDB GmbH and BigchainDB contributors
SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)
Code is Apache-2.0 and docs are CC-BY-4.0
####################
The BigchainDB Class
####################
.. autoclass:: bigchaindb.BigchainDB