summaryrefslogtreecommitdiff
path: root/doc/source/index.rst
blob: 8bf871989b5f8c3fe9d60de3ba2a5f2ee768e2f9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
.. 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`


Running
-------
* :ref:`invoking`
* :ref:`config`


Project format
--------------
* :ref:`formatintro`

  * :ref:`format_structure`
  * :ref:`format_composition`
  * :ref:`format_directives`

* :ref:`projectconf`

  * :ref:`project_essentials`
  * :ref:`project_plugins`
  * :ref:`project_options`
  * :ref:`project_defaults`
  * :ref:`project_builtin_defaults`

* :ref:`format`

  * :ref:`format_basics`
  * :ref:`format_dependencies`
  * :ref:`format_variables`

* :ref:`public`


Builtin Plugins
---------------
* :ref:`plugins`

  * :ref:`plugins_elements`
  * :ref:`plugins_sources`

External Plugins
----------------

* `bst-external <http://buildstream.gitlab.io/bst-external/>`_


Creating Plugins
----------------
* :ref:`pluginauthoring`

  * :ref:`core_framework`


Internals
---------
* :ref:`cachekeys`


Indices and tables
------------------
* :ref:`modindex`
* :ref:`genindex`