diff options
| author | James Ennis <james.ennis@codethink.com> | 2018-04-17 11:59:37 +0100 |
|---|---|---|
| committer | James Ennis <james.ennis@codethink.com> | 2018-04-17 16:55:47 +0100 |
| commit | 07af5330fd9d051bf08e8fef78bf2a5b9d845c4e (patch) | |
| tree | 42d355306eda9f2e01680f44cd96a7d5755cf6f5 | |
| parent | 6dca98db6b077dacd207119351845659d8eee871 (diff) | |
| download | buildstream-restructure-ToC-on-homepage.tar.gz | |
main_core.rst: Change title and moved authoring, sandboxing and cachekeys documentation hererestructure-ToC-on-homepage
| -rw-r--r-- | doc/source/index.rst | 1 | ||||
| -rw-r--r-- | doc/source/main_core.rst | 7 | ||||
| -rw-r--r-- | doc/source/main_general.rst | 14 | ||||
| -rw-r--r-- | doc/source/main_using.rst | 3 |
4 files changed, 6 insertions, 19 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index 2392dcb20..f5b7ec283 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -22,7 +22,6 @@ dependencies. main_install main_using - main_general main_core resources HACKING diff --git a/doc/source/main_core.rst b/doc/source/main_core.rst index ae72cd104..c7be299ba 100644 --- a/doc/source/main_core.rst +++ b/doc/source/main_core.rst @@ -2,8 +2,8 @@ .. _main_core: -Core documentation and reference -================================ +Reference documentation +======================= This section details the core API reference along with other more elaborate details about BuildStream internals. @@ -11,5 +11,8 @@ other more elaborate details about BuildStream internals. .. toctree:: :maxdepth: 2 + authoring + cachekeys + sandboxing core_framework modules diff --git a/doc/source/main_general.rst b/doc/source/main_general.rst deleted file mode 100644 index 17fe7a055..000000000 --- a/doc/source/main_general.rst +++ /dev/null @@ -1,14 +0,0 @@ - - -.. _main_general: - -General Documentation -===================== -This section contains some documentation describing some of BuildStream's prominent features. - -.. toctree:: - :maxdepth: 2 - - artifacts - cachekeys - sandboxing diff --git a/doc/source/main_using.rst b/doc/source/main_using.rst index 73d9716eb..c95a4b51d 100644 --- a/doc/source/main_using.rst +++ b/doc/source/main_using.rst @@ -4,7 +4,7 @@ Using BuildStream ================= -This section details how to use the BuildStream command line interface, work with existing BuildStream projects and how to author a new project. +This section details how to use the BuildStream command line interface and work with existing BuildStream projects. .. toctree:: @@ -12,4 +12,3 @@ This section details how to use the BuildStream command line interface, work wit commands user_config - authoring |