plugins.rst: New file containing plugin documentationjennis/move_plugins_up_in_ToC

3 files changed, 64 insertions, 60 deletions

diff --git a/doc/source/authoring.rst b/doc/source/authoring.rst
index 0ce1d9930..9a94c40d2 100644
--- a/doc/source/authoring.rst
+++ b/doc/source/authoring.rst
@@ -18,63 +18,3 @@ create your own project or modify existing projects.
    public
    projectrefs
 
-
-Plugins
--------
-Plugins provide their own individual plugin specific YAML configurations,
-The element ``.bst`` files can specify plugin specific configuration in
-the :ref:`config section <format_config>`, while sources declared on a
-given element specify their plugin specific configuration directly
-:ref:`in their source declarations <format_sources>`.
-
-
-Elements
-~~~~~~~~
-The following element types are provided with BuildStream:
-
-
-General elements
-''''''''''''''''
-
-* :mod:`stack <elements.stack>` - Symbolic Element for dependency grouping
-* :mod:`import <elements.import>` - Import sources directly
-* :mod:`compose <elements.compose>` - Compose the output of multiple elements
-* :mod:`script <elements.script>` - Run scripts to create output
-* :mod:`junction <elements.junction>` - Integrate subprojects
-* :mod:`filter <elements.filter>` - Extract a subset of files from another element
-
-
-Build elements
-''''''''''''''
-
-* :mod:`manual <elements.manual>` - Manual Build Element
-* :mod:`autotools <elements.autotools>` - Autotools Build Element
-* :mod:`cmake <elements.cmake>` - CMake Build Element
-* :mod:`qmake <elements.qmake>` - QMake Build Element
-* :mod:`distutils <elements.distutils>` - Python Distutils Build Element
-* :mod:`makemaker <elements.makemaker>` - Perl MakeMaker Build Element
-* :mod:`modulebuild <elements.modulebuild>` - Perl Module::Build Build Element
-* :mod:`meson <elements.meson>` - Meson Build Element
-* :mod:`pip <elements.pip>` - Pip build element
-
-
-Sources
-~~~~~~~
-The following source types are provided with BuildStream:
-
-* :mod:`local <sources.local>` - A Source implementation for local files and directories
-* :mod:`tar <sources.tar>` - A Source implementation for tarballs
-* :mod:`zip <sources.zip>` - A Source implementation for zip archives
-* :mod:`git <sources.git>` - A Source implementation for git
-* :mod:`bzr <sources.bzr>` - A Source implementation for bazaar
-* :mod:`ostree <sources.ostree>` - A Source implementation for ostree
-* :mod:`patch <sources.patch>` - A Source implementation for applying local patches
-* :mod:`deb <sources.deb>` - A Source implementation for deb packages
-
-
-External plugins
-----------------
-External plugins need to be installed separately, here is
-a list of BuildStream plugin projects known to us at this time:
-
-* `bst-external <http://buildstream.gitlab.io/bst-external/>`_
diff --git a/doc/source/main_core.rst b/doc/source/main_core.rst
index c7be299ba..052df1ee9 100644
--- a/doc/source/main_core.rst
+++ b/doc/source/main_core.rst
@@ -12,6 +12,7 @@ other more elaborate details about BuildStream internals.
    :maxdepth: 2
 
    authoring
+   plugins
    cachekeys
    sandboxing
    core_framework
diff --git a/doc/source/plugins.rst b/doc/source/plugins.rst
new file mode 100644
index 000000000..10e042372
--- /dev/null
+++ b/doc/source/plugins.rst
@@ -0,0 +1,63 @@
+
+.. _plugins:
+
+
+Plugins
+=======
+Plugins provide their own individual plugin specific YAML configurations,
+The element ``.bst`` files can specify plugin specific configuration in
+the :ref:`config section <format_config>`, while sources declared on a
+given element specify their plugin specific configuration directly
+:ref:`in their source declarations <format_sources>`.
+
+
+Elements
+--------
+The following element types are provided with BuildStream:
+
+
+General elements
+~~~~~~~~~~~~~~~~
+
+* :mod:`stack <elements.stack>` - Symbolic Element for dependency grouping
+* :mod:`import <elements.import>` - Import sources directly
+* :mod:`compose <elements.compose>` - Compose the output of multiple elements
+* :mod:`script <elements.script>` - Run scripts to create output
+* :mod:`junction <elements.junction>` - Integrate subprojects
+* :mod:`filter <elements.filter>` - Extract a subset of files from another element
+
+
+Build elements
+~~~~~~~~~~~~~~
+
+* :mod:`manual <elements.manual>` - Manual Build Element
+* :mod:`autotools <elements.autotools>` - Autotools Build Element
+* :mod:`cmake <elements.cmake>` - CMake Build Element
+* :mod:`qmake <elements.qmake>` - QMake Build Element
+* :mod:`distutils <elements.distutils>` - Python Distutils Build Element
+* :mod:`makemaker <elements.makemaker>` - Perl MakeMaker Build Element
+* :mod:`modulebuild <elements.modulebuild>` - Perl Module::Build Build Element
+* :mod:`meson <elements.meson>` - Meson Build Element
+* :mod:`pip <elements.pip>` - Pip build element
+
+
+Sources
+-------
+The following source types are provided with BuildStream:
+
+* :mod:`local <sources.local>` - A Source implementation for local files and directories
+* :mod:`tar <sources.tar>` - A Source implementation for tarballs
+* :mod:`zip <sources.zip>` - A Source implementation for zip archives
+* :mod:`git <sources.git>` - A Source implementation for git
+* :mod:`bzr <sources.bzr>` - A Source implementation for bazaar
+* :mod:`ostree <sources.ostree>` - A Source implementation for ostree
+* :mod:`patch <sources.patch>` - A Source implementation for applying local patches
+* :mod:`deb <sources.deb>` - A Source implementation for deb packages
+
+
+External plugins
+----------------
+External plugins need to be installed separately, here is
+a list of BuildStream plugin projects known to us at this time:
+
+* `bst-external <http://buildstream.gitlab.io/bst-external/>`_