documentation: Set page titles manually in python modules.

9 files changed, 36 insertions, 4 deletions

diff --git a/buildstream/context.py b/buildstream/context.py
index 64acd4fc4..afc46fe59 100644
--- a/buildstream/context.py
+++ b/buildstream/context.py
@@ -18,7 +18,9 @@
 #  Authors:
 #        Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
 
-"""Context for running BuildStream pipelines
+"""
+Context
+=======
 
 The :class:`.Context` object holds all of the user preferences
 and context for a given invocation of BuildStream.
diff --git a/buildstream/element.py b/buildstream/element.py
index b612b268e..187c7788a 100644
--- a/buildstream/element.py
+++ b/buildstream/element.py
@@ -18,6 +18,11 @@
 #  Authors:
 #        Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
 
+"""
+Element
+=======
+"""
+
 import os
 import sys
 import re
diff --git a/buildstream/exceptions.py b/buildstream/exceptions.py
index 735cc588d..68e43ec37 100644
--- a/buildstream/exceptions.py
+++ b/buildstream/exceptions.py
@@ -17,6 +17,10 @@
 #
 #  Authors:
 #        Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
+"""
+Exceptions
+==========
+"""
 
 from enum import Enum
 
diff --git a/buildstream/plugin.py b/buildstream/plugin.py
index 7253c8398..ae5f4018f 100644
--- a/buildstream/plugin.py
+++ b/buildstream/plugin.py
@@ -17,6 +17,10 @@
 #
 #  Authors:
 #        Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
+"""
+Plugin
+======
+"""
 
 import os
 import datetime
diff --git a/buildstream/project.py b/buildstream/project.py
index e6e088e2e..aeb6b5f39 100644
--- a/buildstream/project.py
+++ b/buildstream/project.py
@@ -18,7 +18,9 @@
 #  Authors:
 #        Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
 
-"""Loaded Project Configuration
+"""
+Project
+=======
 
 The :class:`.Project` object holds all of the project settings from
 the project configuration file including the project directory it
diff --git a/buildstream/sandbox.py b/buildstream/sandbox.py
index 8ad48a4b3..4462f4424 100644
--- a/buildstream/sandbox.py
+++ b/buildstream/sandbox.py
@@ -18,13 +18,16 @@
 #  Authors:
 #        Andrew Leeming <andrew.leeming@codethink.co.uk>
 #        Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
-"""Sandbox abstraction layer.
+"""
+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
 conform to this interface.
 """
+
 import os
 
 from . import ImplError
diff --git a/buildstream/scriptelement.py b/buildstream/scriptelement.py
index d84ca9157..ce9bf95b5 100644
--- a/buildstream/scriptelement.py
+++ b/buildstream/scriptelement.py
@@ -18,7 +18,11 @@
 #  Authors:
 #        Jonathan Maw <jonathan.maw@codethink.co.uk>
 
-"""The ScriptElement class is a convenience class one can derive for
+"""
+ScriptElement
+=============
+
+The ScriptElement class is a convenience class one can derive for
 implementing elements that stage elements and run command-lines on them.
 
 Any derived classes must write their own configure() implementation, using
diff --git a/buildstream/source.py b/buildstream/source.py
index fcd4d6256..e0974228b 100644
--- a/buildstream/source.py
+++ b/buildstream/source.py
@@ -17,6 +17,10 @@
 #
 #  Authors:
 #        Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
+"""
+Source
+======
+"""
 
 import os
 import hashlib
diff --git a/buildstream/utils.py b/buildstream/utils.py
index c1243e275..c923eb795 100644
--- a/buildstream/utils.py
+++ b/buildstream/utils.py
@@ -17,6 +17,10 @@
 #
 #  Authors:
 #        Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
+"""
+Utilities
+=========
+"""
 
 import os
 import errno