diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2017-03-10 18:31:16 +0900 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2017-03-10 18:31:16 +0900 |
| commit | cca315b9d219e96fba899f8d0d94448dcd451ac9 (patch) | |
| tree | fcc20659129da8ae7c0ab37f9c19fa52f030ef17 /doc | |
| parent | 7ad82778f8c6afeb1252f1315d424714ac0eea3e (diff) | |
| download | buildstream-cca315b9d219e96fba899f8d0d94448dcd451ac9.tar.gz | |
Facelift for documentation main index.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/index.rst | 39 |
1 files changed, 20 insertions, 19 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index 30365e5b1..cd17bf0dd 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -24,31 +24,15 @@ elements for doing more elaborate things such as deploying software in special w Using BuildStream ----------------- -Here are some resources to help you get off the ground when creating your very first -BuildStream project. +Here are some resources to help you get off the ground when creating your very +first BuildStream project. * :ref:`format` - -Core Framework --------------- - -* :mod:`Plugin <buildstream.plugin>` - Base Class for all plugins -* :mod:`Source <buildstream.source>` - Base Source Class -* :mod:`Element <buildstream.element>` - Base Element Class -* :mod:`BuildElement <buildstream.buildelement>` - Build Element Class -* :mod:`Context <buildstream.context>` - Invocation Context -* :mod:`Project <buildstream.project>` - Loaded Project -* :mod:`Sandbox <buildstream.sandbox>` - Sandbox Abstraction Class -* :mod:`Utilities <buildstream.utils>` - Utilities for Plugins - - -Plugins -------- - Elements ~~~~~~~~ +The following element types are provided with BuildStream: * :mod:`stack` - Symbolic Element for dependency grouping * :mod:`import` - Import sources directly @@ -63,12 +47,29 @@ Elements Sources ~~~~~~~ +The following source types are provided with BuildStream: * :mod:`local` - A Source implementation local files and directories * :mod:`git` - A Source implementation for git * :mod:`ostree` - A Source implementation for ostree +Core Framework +-------------- +The core public APIs are of interest to anyone who wishes to +implement custom :mod:`Element <buildstream.element>` or +:mod:`Source <buildstream.source>` plugins. + +* :mod:`Plugin <buildstream.plugin>` - Base Class for all plugins +* :mod:`Source <buildstream.source>` - Base Source Class +* :mod:`Element <buildstream.element>` - Base Element Class +* :mod:`BuildElement <buildstream.buildelement>` - Build Element Class +* :mod:`Context <buildstream.context>` - Invocation Context +* :mod:`Project <buildstream.project>` - Loaded Project +* :mod:`Sandbox <buildstream.sandbox>` - Build Sandbox +* :mod:`Utilities <buildstream.utils>` - Utilities for Plugins + + Indices and tables ------------------ * :ref:`modindex` |