diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-01-17 19:08:03 +0900 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-01-17 19:08:03 +0900 |
| commit | 88260c7a57f9c797af3f8222c02b257b25d25d45 (patch) | |
| tree | 15a87fb80b83974d99e524f30fe7debaccc8ac54 /doc/source/format.rst | |
| parent | 03412a9e8a13e6c5f50dec95e067c2ae6900d08f (diff) | |
| download | buildstream-88260c7a57f9c797af3f8222c02b257b25d25d45.tar.gz | |
Documentation: Restructured toplevel documentationdocs-reorganization
This is intended to make things easier to find for the
various types of people searching for stuff.
o The installation instructions remain on the main page.
o Three main separate pages have been created
- Using BuildStream
- Authoring BuildStream projects
- Core API reference, for plugin authors
o The "Authoring projects" section swallows the
previous plugin index; so one can find the plugin one
is looking for on the same page as the rest of the format
docs
o The plugin authoring section has been swallowed by the
core API reference section, with a note that this is useful
especially for plugin authors.
Diffstat (limited to 'doc/source/format.rst')
| -rw-r--r-- | doc/source/format.rst | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/source/format.rst b/doc/source/format.rst index 6f6e2f0ec..fe4f57ea1 100644 --- a/doc/source/format.rst +++ b/doc/source/format.rst @@ -91,6 +91,8 @@ to the elements on which they depend here. See `Dependencies`_ for more informat on the dependency model. +.. _format_sources: + Sources ~~~~~~~ @@ -167,6 +169,8 @@ build instructions are run for this element. Environment variables can also be declared and overridden in the :ref:`projectconf` +.. _format_config: + Config ~~~~~~ |