diff options
| author | James Ennis <james.ennis@codethink.com> | 2018-04-17 12:05:07 +0100 |
|---|---|---|
| committer | James Ennis <james.ennis@codethink.com> | 2018-04-17 16:55:47 +0100 |
| commit | 6dca98db6b077dacd207119351845659d8eee871 (patch) | |
| tree | 5abb5adfe42b664d48853eaf2bc373bead426e01 | |
| parent | b8b4159ce3c12525ce283553ffee9f3b60a608b9 (diff) | |
| download | buildstream-6dca98db6b077dacd207119351845659d8eee871.tar.gz | |
core_framework.rst: New file containing content that was in main_core.rst
| -rw-r--r-- | doc/source/core_framework.rst | 18 | ||||
| -rw-r--r-- | doc/source/main_core.rst | 21 |
2 files changed, 19 insertions, 20 deletions
diff --git a/doc/source/core_framework.rst b/doc/source/core_framework.rst new file mode 100644 index 000000000..8caae1f3f --- /dev/null +++ b/doc/source/core_framework.rst @@ -0,0 +1,18 @@ + + +.. _core_framework: + +Core framework +-------------- +The core public APIs are of interest to anyone who wishes to +implement custom :mod:`Element <buildstream.element>` or +:mod:`Source <buildstream.source>` plugins, and can also be +useful for working on BuildStream itself. + +* :mod:`Plugin <buildstream.plugin>` - Base Class for all plugins +* :mod:`Source <buildstream.source>` - Base Source Class +* :mod:`Element <buildstream.element>` - Base Element Class +* :mod:`BuildElement <buildstream.buildelement>` - Build Element Class +* :mod:`ScriptElement <buildstream.scriptelement>` - Script Element Class +* :mod:`Sandbox <buildstream.sandbox.sandbox>` - Build Sandbox +* :mod:`Utilities <buildstream.utils>` - Utilities for Plugins diff --git a/doc/source/main_core.rst b/doc/source/main_core.rst index 608d04851..ae72cd104 100644 --- a/doc/source/main_core.rst +++ b/doc/source/main_core.rst @@ -8,27 +8,8 @@ This section details the core API reference along with other more elaborate details about BuildStream internals. -.. _core_framework: - -Core framework --------------- -The core public APIs are of interest to anyone who wishes to -implement custom :mod:`Element <buildstream.element>` or -:mod:`Source <buildstream.source>` plugins, and can also be -useful for working on BuildStream itself. - -* :mod:`Plugin <buildstream.plugin>` - Base Class for all plugins -* :mod:`Source <buildstream.source>` - Base Source Class -* :mod:`Element <buildstream.element>` - Base Element Class -* :mod:`BuildElement <buildstream.buildelement>` - Build Element Class -* :mod:`ScriptElement <buildstream.scriptelement>` - Script Element Class -* :mod:`Sandbox <buildstream.sandbox.sandbox>` - Build Sandbox -* :mod:`Utilities <buildstream.utils>` - Utilities for Plugins - - -Internals ---------- .. toctree:: :maxdepth: 2 + core_framework modules |