doc/source/index.rst

..
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

.. toctree::
   :maxdepth: 2

BuildStream Plugins Documentation
=================================
This is a collection of plugins to use with Buildstream.

To use these plugins in your project, can install them though 
`pip <https://pypi.org/project/buildstream-plugins/>`_.
Then, follow the
`plugin loading documentation <https://docs.buildstream.build/master/format_project.html#loading-plugins>`_
so your project can utilize them.

.. toctree::
   :maxdepth: 1
   :caption: Element Plugins

   elements/autotools
   elements/cmake
   elements/make
   elements/meson
   elements/pip
   elements/setuptools

.. toctree::
   :maxdepth: 1
   :caption: Source Plugins

   sources/bzr
   sources/cargo
   sources/docker
   sources/git
   sources/patch
   sources/pip

.. toctree::
   :maxdepth: 1
   :caption: Source Mirror Plugins

   sourcemirrors/simple_mirror
   sourcemirrors/gitlab_lfs_mirror