Problem: Code Reference docs hidden in appendices

Solution: Move the Code Reference docs into their own section
This commit is contained in:
Troy McConaghy 2018-08-19 21:13:00 +02:00
parent bd49a3804f
commit f5706079f1
6 changed files with 25 additions and 3 deletions

View File

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

View File

@ -0,0 +1,24 @@
.. 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
Code Reference
==============
This section contains auto-generated documentation of various functions, classes and methods
in the BigchainDB Server code, based on Python docstrings in the code itself.
.. warning::
While we try to keep docstrings accurate,
if you want to know *for sure* what the code does,
then you have to read the code itself.
.. toctree::
:maxdepth: 1
the-bigchaindb-class
backend
commands

View File

@ -23,4 +23,5 @@ BigchainDB Server Documentation
data-models/index data-models/index
k8s-deployment-template/index k8s-deployment-template/index
release-notes release-notes
code-reference/index
appendices/index appendices/index