From f8bb29535ae4e1b875360e44ebaae27488e3c433 Mon Sep 17 00:00:00 2001 From: Troy McConaghy Date: Tue, 4 Sep 2018 12:17:27 +0200 Subject: [PATCH] Problem: Code Reference docs hidden in appendices (#2473) Solution: Move the Code Reference docs into their own section --- docs/server/source/appendices/index.rst | 3 --- .../backend.rst | 0 .../commands.rst | 0 docs/server/source/code-reference/index.rst | 24 +++++++++++++++++++ .../the-bigchaindb-class.rst | 0 docs/server/source/index.rst | 1 + 6 files changed, 25 insertions(+), 3 deletions(-) rename docs/server/source/{appendices => code-reference}/backend.rst (100%) rename docs/server/source/{appendices => code-reference}/commands.rst (100%) create mode 100644 docs/server/source/code-reference/index.rst rename docs/server/source/{appendices => code-reference}/the-bigchaindb-class.rst (100%) diff --git a/docs/server/source/appendices/index.rst b/docs/server/source/appendices/index.rst index ea02aed6..24276f2d 100755 --- 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 b/docs/server/source/code-reference/backend.rst similarity index 100% rename from docs/server/source/appendices/backend.rst rename to docs/server/source/code-reference/backend.rst diff --git a/docs/server/source/appendices/commands.rst b/docs/server/source/code-reference/commands.rst similarity index 100% rename from docs/server/source/appendices/commands.rst rename to docs/server/source/code-reference/commands.rst diff --git a/docs/server/source/code-reference/index.rst b/docs/server/source/code-reference/index.rst new file mode 100644 index 00000000..11d42b66 --- /dev/null +++ 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 + \ No newline at end of file diff --git a/docs/server/source/appendices/the-bigchaindb-class.rst b/docs/server/source/code-reference/the-bigchaindb-class.rst similarity index 100% rename from docs/server/source/appendices/the-bigchaindb-class.rst rename to docs/server/source/code-reference/the-bigchaindb-class.rst diff --git a/docs/server/source/index.rst b/docs/server/source/index.rst index ced2a433..534cc6fd 100644 --- 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