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

7 files changed, 22 insertions, 21 deletions

diff --git a/buildstream/buildelement.py b/buildstream/buildelement.py
index 5f9a856d1..20c5e620f 100644
--- a/buildstream/buildelement.py
+++ b/buildstream/buildelement.py
@@ -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.
 
diff --git a/buildstream/element.py b/buildstream/element.py
index 796d79d66..e876eb120 100644
--- a/buildstream/element.py
+++ b/buildstream/element.py
@@ -19,8 +19,8 @@
 #        Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
 
 """
-Element
-=======
+Element - Base element class
+============================
 
 
 .. _core_element_abstract_methods:
diff --git a/buildstream/plugin.py b/buildstream/plugin.py
index b208e2d06..0c216ed5d 100644
--- a/buildstream/plugin.py
+++ b/buildstream/plugin.py
@@ -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>`.
 
diff --git a/buildstream/sandbox/sandbox.py b/buildstream/sandbox/sandbox.py
index 3ab75f1a8..c174c4adb 100644
--- a/buildstream/sandbox/sandbox.py
+++ b/buildstream/sandbox/sandbox.py
@@ -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
diff --git a/buildstream/scriptelement.py b/buildstream/scriptelement.py
index 95e6928ee..a0b12eef5 100644
--- a/buildstream/scriptelement.py
+++ b/buildstream/scriptelement.py
@@ -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.
 
diff --git a/buildstream/source.py b/buildstream/source.py
index fa547d641..470a407ad 100644
--- a/buildstream/source.py
+++ b/buildstream/source.py
@@ -18,8 +18,8 @@
 #  Authors:
 #        Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
 """
-Source
-======
+Source - base source class
+==========================
 
 
 .. _core_source_abstract_methods:
diff --git a/doc/source/core_framework.rst b/doc/source/core_framework.rst
index 8caae1f3f..5f0db07ab 100644
--- a/doc/source/core_framework.rst
+++ b/doc/source/core_framework.rst
@@ -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