Commit 96c219d0 authored by Tristan Van Berkom's avatar Tristan Van Berkom

doc/source/core_framework.rst: Use a toctree instead of links

parent 5f794829
......@@ -18,8 +18,8 @@
# Authors:
# Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
"""
BuildElement
============
BuildElement - Abstract class for build elements
================================================
The BuildElement class is a convenience element one can derive from for
implementing the most common case of element.
......
......@@ -19,8 +19,8 @@
# Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
"""
Element
=======
Element - Base element class
============================
.. _core_element_abstract_methods:
......
......@@ -18,8 +18,8 @@
# Authors:
# Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
"""
Plugin
======
Plugin - Base plugin class
==========================
BuildStream supports third party plugins to define additional kinds of
:mod:`Elements <buildstream.element>` and :mod:`Sources <buildstream.source>`.
......
......@@ -19,9 +19,8 @@
# Andrew Leeming <andrew.leeming@codethink.co.uk>
# Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
"""
Sandbox
=======
Sandbox - The build sandbox
===========================
:class:`.Element` plugins which want to interface with the sandbox
need only understand this interface, while it may be given a different
sandbox implementation, any sandbox implementation it is given will
......
......@@ -19,9 +19,8 @@
# Jonathan Maw <jonathan.maw@codethink.co.uk>
"""
ScriptElement
=============
ScriptElement - Abstract class for scripting elements
=====================================================
The ScriptElement class is a convenience class one can derive for
implementing elements that stage elements and run command-lines on them.
......
......@@ -18,8 +18,8 @@
# Authors:
# Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
"""
Source
======
Source - base source class
==========================
.. _core_source_abstract_methods:
......
......@@ -9,10 +9,13 @@ 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
.. toctree::
:maxdepth: 1
buildstream.plugin
buildstream.source
buildstream.element
buildstream.buildelement
buildstream.scriptelement
buildstream.sandbox.sandbox
buildstream.utils
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment