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

Solution: Move the Code Reference docs into their own section
bigchaindb · Sep 4, 2018 · f8bb295 · f8bb295
1 parent 230a5b2
commit f8bb295
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 3 deletions.
diff --git a/docs/server/source/appendices/index.rst b/docs/server/source/appendices/index.rst
@@ -11,9 +11,6 @@ Appendices
 
    json-serialization
    cryptography
-   the-bigchaindb-class
-   backend
-   commands
    aws-setup
    generate-key-pair-for-ssh
    firewall-notes

diff --git a/docs/server/source/appendices/backend.rst → .../server/source/code-reference/backend.rst b/docs/server/source/appendices/backend.rst → .../server/source/code-reference/backend.rst
diff --git a/docs/server/source/appendices/commands.rst → ...server/source/code-reference/commands.rst b/docs/server/source/appendices/commands.rst → ...server/source/code-reference/commands.rst
diff --git a/docs/server/source/code-reference/index.rst b/docs/server/source/code-reference/index.rst
@@ -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
+
diff --git a/...ource/appendices/the-bigchaindb-class.rst → ...e/code-reference/the-bigchaindb-class.rst b/...ource/appendices/the-bigchaindb-class.rst → ...e/code-reference/the-bigchaindb-class.rst
diff --git a/docs/server/source/index.rst b/docs/server/source/index.rst
@@ -23,4 +23,5 @@ BigchainDB Server Documentation
    data-models/index
    k8s-deployment-template/index
    release-notes
+   code-reference/index
    appendices/index