diff options
| author | James Ennis <james.ennis@codethink.com> | 2018-04-16 17:48:36 +0100 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.van.berkom@gmail.com> | 2018-04-17 16:52:27 +0000 |
| commit | 5d2f6ec67c64bf53ed41da1b6314ce887a56b214 (patch) | |
| tree | 73f55977995fda4fb9ed2c1b49fef4d0c4f14305 /doc/source | |
| parent | 4a49cedb153d5b0cae86d40064a53d6e18214ccd (diff) | |
| download | buildstream-5d2f6ec67c64bf53ed41da1b6314ce887a56b214.tar.gz | |
Add a general documentation section
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/index.rst | 4 | ||||
| -rw-r--r-- | doc/source/main_core.rst | 7 | ||||
| -rw-r--r-- | doc/source/main_general.rst | 14 |
3 files changed, 20 insertions, 5 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index c7f17ce0e..059bfe564 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -27,14 +27,14 @@ dependencies. :maxdepth: 2 main_using - artifacts .. toctree:: :maxdepth: 2 + main_general main_core - modules + .. toctree:: :maxdepth: 2 diff --git a/doc/source/main_core.rst b/doc/source/main_core.rst index d6c04268e..78d8cc264 100644 --- a/doc/source/main_core.rst +++ b/doc/source/main_core.rst @@ -25,9 +25,10 @@ useful for working on BuildStream itself. * :mod:`Sandbox <buildstream.sandbox.sandbox>` - Build Sandbox * :mod:`Utilities <buildstream.utils>` - Utilities for Plugins + +Internals +--------- .. toctree:: :maxdepth: 2 - :caption: Internals - cachekeys - sandboxing + modules diff --git a/doc/source/main_general.rst b/doc/source/main_general.rst new file mode 100644 index 000000000..17fe7a055 --- /dev/null +++ b/doc/source/main_general.rst @@ -0,0 +1,14 @@ + + +.. _main_general: + +General Documentation +===================== +This section contains some documentation describing some of BuildStream's prominent features. + +.. toctree:: + :maxdepth: 2 + + artifacts + cachekeys + sandboxing |