mirror of
https://github.com/bigchaindb/bigchaindb.git
synced 2024-10-13 13:34:05 +00:00
Problem: Code Reference docs hidden in appendices (#2473)
Solution: Move the Code Reference docs into their own section
This commit is contained in:
parent
230a5b2d69
commit
f8bb29535a
@ -11,9 +11,6 @@ Appendices
|
||||
|
||||
json-serialization
|
||||
cryptography
|
||||
the-bigchaindb-class
|
||||
backend
|
||||
commands
|
||||
aws-setup
|
||||
generate-key-pair-for-ssh
|
||||
firewall-notes
|
||||
|
24
docs/server/source/code-reference/index.rst
Normal file
24
docs/server/source/code-reference/index.rst
Normal 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
|
||||
|
@ -23,4 +23,5 @@ BigchainDB Server Documentation
|
||||
data-models/index
|
||||
k8s-deployment-template/index
|
||||
release-notes
|
||||
code-reference/index
|
||||
appendices/index
|
||||
|
Loading…
x
Reference in New Issue
Block a user