From 505fbe905f900f67efc60f0b206da27cb449e4ba Mon Sep 17 00:00:00 2001
From: Ronald Bradford <ronald.bradford@gmail.com>
Date: Mon, 28 Sep 2015 16:44:53 -0400
Subject: [PATCH] Add heat template plugins to documentation

As per:
http://lists.openstack.org/pipermail/openstack-dev/2015-August/073338.html

Pull in the plugins and document them based on their docstrings.

Change-Id: I6b17961b1c366b629139b8ef7ca27c30d31e9da0
---
 doc/source/conf.py                      |  1 +
 doc/source/heat-templates.rst           | 11 +++++++++++
 doc/source/index.rst                    |  1 +
 magnum/conductor/template_definition.py |  8 ++++++++
 4 files changed, 21 insertions(+)
 create mode 100644 doc/source/heat-templates.rst

diff --git a/doc/source/conf.py b/doc/source/conf.py
index b0e5db0dc5..aa2c780f5e 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -22,6 +22,7 @@ sys.path.insert(0, os.path.abspath('../..'))
 extensions = [
     'sphinx.ext.autodoc',
     #'sphinx.ext.intersphinx',
+    'stevedore.sphinxext',
     'oslosphinx'
 ]
 
diff --git a/doc/source/heat-templates.rst b/doc/source/heat-templates.rst
new file mode 100644
index 0000000000..5d0933f346
--- /dev/null
+++ b/doc/source/heat-templates.rst
@@ -0,0 +1,11 @@
+===========================
+ Heat Template Definitions
+===========================
+
+Heat Templates are what Magnum uses to generate a Bay. These various template
+definitions provide a mapping of Magnum object attributes to Heat templates
+parameters, along with Magnum consumable template outputs. The result of a
+Heat template should be a full Container Orchestration Environment.
+
+.. list-plugins:: magnum.template_definitions
+   :detailed:
diff --git a/doc/source/index.rst b/doc/source/index.rst
index ead17ea847..07068eccba 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -78,3 +78,4 @@ Developer Info
    dev/dev-quickstart
    dev/dev-manual-devstack
    contributing
+   heat-templates
diff --git a/magnum/conductor/template_definition.py b/magnum/conductor/template_definition.py
index 2ee0cb0dc6..6661f68fe7 100644
--- a/magnum/conductor/template_definition.py
+++ b/magnum/conductor/template_definition.py
@@ -363,6 +363,8 @@ class BaseTemplateDefinition(TemplateDefinition):
 
 
 class AtomicK8sTemplateDefinition(BaseTemplateDefinition):
+    """Kubernetes template for a Fedora Atomic VM."""
+
     provides = [
         {'server_type': 'vm',
          'os': 'fedora-atomic',
@@ -442,6 +444,8 @@ class AtomicK8sTemplateDefinition(BaseTemplateDefinition):
 
 
 class CoreOSK8sTemplateDefinition(AtomicK8sTemplateDefinition):
+    """Kubernetes template for CoreOS VM."""
+
     provides = [
         {'server_type': 'vm', 'os': 'coreos', 'coe': 'kubernetes'},
     ]
@@ -476,6 +480,8 @@ class CoreOSK8sTemplateDefinition(AtomicK8sTemplateDefinition):
 
 
 class AtomicSwarmTemplateDefinition(BaseTemplateDefinition):
+    """Docker swarm template for a Fedora Atomic VM."""
+
     provides = [
         {'server_type': 'vm', 'os': 'fedora-atomic', 'coe': 'swarm'},
     ]
@@ -544,6 +550,8 @@ class AtomicSwarmTemplateDefinition(BaseTemplateDefinition):
 
 
 class UbuntuMesosTemplateDefinition(BaseTemplateDefinition):
+    """Mesos template for Ubuntu VM."""
+
     provides = [
         {'server_type': 'vm', 'os': 'ubuntu', 'coe': 'mesos'},
     ]