blob: 36aa749bc7ac0f1047f0cd9aaa125a2e9ebf7d54 [file] [log] [blame]
.. BuildStream documentation master file, created by
sphinx-quickstart on Mon Nov 7 21:03:37 2016.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. toctree::
:maxdepth: 2
:hidden:
modules
BuildStream Documentation
=========================
About BuildStream
-----------------
BuildStream is a flexible and extensible framework for the modelling of build
pipelines in a declarative YAML format, written in python.
These pipelines are composed of abstract elements which perform mutations on
on *filesystem data* as input and output, and are related to eachother by their
dependencies.
Installing
----------
* :ref:`installing`
* :ref:`docker`
* :ref:`artifacts`
Documentation
-------------
* :ref:`main_using`
* :ref:`main_authoring`
* :ref:`main_core`
Indices and tables
------------------
* :ref:`modindex`
* :ref:`genindex`