diff options
| author | Sam Thursfield <sam.thursfield@codethink.co.uk> | 2018-01-05 11:56:04 +0000 |
|---|---|---|
| committer | Sam Thursfield <sam.thursfield@codethink.co.uk> | 2018-01-05 12:00:01 +0000 |
| commit | 6636f5a8ede5b1b6204f913260913b9e637bc6da (patch) | |
| tree | 9bf30d483e45a509f8f25f529b3e33b322b935e2 | |
| parent | c9551eab009b3493dde8d9a038c1783a5c4c624c (diff) | |
| download | buildstream-sam/plugin-docs.tar.gz | |
doc: Promote documention on how to use external plugins up one levelsam/plugin-docs
Currently the front page at https://buildstream.gitlab.io/buildstream/
doesn't make it easy to discover how to use external plugins.
There is an 'External plugins' heading which simply links to the
bst-external documentation (which also doesn't document how to use
external plugins) and that is all.
By promoting the "Plugin Origins and Versions" item up a level, we
cause it to appear in the table of contents on the front page making
it easier to find.
| -rw-r--r-- | doc/source/projectconf.rst | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/source/projectconf.rst b/doc/source/projectconf.rst index c85d3818c..c2741e2ef 100644 --- a/doc/source/projectconf.rst +++ b/doc/source/projectconf.rst @@ -79,8 +79,10 @@ with an artifact share. url: https://foo.com/artifacts +.. _project_plugins: + Plugin Origins and Versions -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +--------------------------- The BuildStream format is guaranteed to be backwards compatible with any earlier releases. The core YAML format, the format supported @@ -96,7 +98,7 @@ Note that elements or plugins with the same name from different origins are not permitted. Plugin specification format -''''''''''''''''''''''''''' +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code:: yaml @@ -146,7 +148,7 @@ Plugin specification format mysource: 0 Project Version Format -'''''''''''''''''''''' +~~~~~~~~~~~~~~~~~~~~~~ The project's minimum required version of buildstream is specified in ``project.conf`` with the ``format-version`` field, e.g. |