From b4013fd7f6c6999c9cd167316911756671708576 Mon Sep 17 00:00:00 2001
From: Angus Salkeld <asalkeld@mirantis.com>
Date: Mon, 15 Sep 2014 14:30:02 +1000
Subject: [PATCH] Fix some sphinx warnings/errors

- don't have link name clashes
- fix broken links
- pydoc fixes

Change-Id: I60e5bc1dda2eb66f5cb4d98cf048c73872278092
---
 doc/source/template_guide/contrib.rst  | 13 ++++++-------
 doc/source/template_guide/hot_spec.rst |  4 ++--
 heat/engine/clients/os/neutron.py      |  6 +++---
 heat/engine/properties.py              |  6 +++---
 4 files changed, 14 insertions(+), 15 deletions(-)

diff --git a/doc/source/template_guide/contrib.rst b/doc/source/template_guide/contrib.rst
index 0fc31163e..507517999 100644
--- a/doc/source/template_guide/contrib.rst
+++ b/doc/source/template_guide/contrib.rst
@@ -27,7 +27,7 @@ a generic Openstack deployment and the Rackspace Cloud.
 Rackspace resources depend on the dev branch of
 `pyrax <https://github.com/rackspace/pyrax/tree/dev>`_ to work
 properly. More information about them can be found in the
-`README
+`RACKSPACE_README
 <https://github.com/openstack/heat/blob/master/contrib/rackspace/README.md>`_.
 
 
@@ -41,20 +41,19 @@ DockerInc Resource
 
 This plugin enables the use of  Docker containers in a Heat template and
 requires the `docker-py <https://pypi.python.org/pypi/docker-py>`_
-package. You can find more information in the `README
-<https://github.com/openstack/heat/blob/master/contrib/heat_docker/heat_docker
-/README.md>`_.
+package. You can find more information in the `DOCKER_README
+<https://github.com/openstack/heat/blob/master/contrib/heat_docker/README.md>`_.
 
 .. resourcepages:: DockerInc::
 
 Nova Flavor Resource
-------------------
+--------------------
 
 .. rubric:: This resource is not enabled by default.
 
 This plugin enables dynamic creation of Nova flavors through Heat. You can
-find more information in the `README
-<https://github.com/openstack/heat/blob/master/contrib/nova_flavor/nova_flavor
+find more information in the `NOVA_FLAVOR_README
+<https://github.com/openstack/heat/blob/master/contrib/nova_flavor
 /README.md>`_.
 
 .. resourcepages:: NovaFlavor::
diff --git a/doc/source/template_guide/hot_spec.rst b/doc/source/template_guide/hot_spec.rst
index 18f92c5f2..ceb4cf605 100644
--- a/doc/source/template_guide/hot_spec.rst
+++ b/doc/source/template_guide/hot_spec.rst
@@ -382,7 +382,7 @@ For example:
       constraints:
         - custom_constraint: nova.keypair
 
-.. _hot_spec_pseudo_parameters
+.. _hot_spec_pseudo_parameters:
 
 Pseudo Parameters
 -----------------
@@ -727,7 +727,7 @@ given as single parameter to the get_resource function.
 
 
 list_join
---------
+---------
 The *list_join* function joins a list of strings with the given delimiter. This
 function is available beginning with the `2014-10-16` version of HOT.
 The syntax of the list_join function is as follows:
diff --git a/heat/engine/clients/os/neutron.py b/heat/engine/clients/os/neutron.py
index 7bb7273d6..f86dab8eb 100644
--- a/heat/engine/clients/os/neutron.py
+++ b/heat/engine/clients/os/neutron.py
@@ -86,10 +86,10 @@ class NeutronClientPlugin(client_plugin.ClientPlugin):
         return subnet_info['subnet']['network_id']
 
     def get_secgroup_uuids(self, security_groups):
-        '''
-        Returns a list of security group UUIDs.
+        '''Returns a list of security group UUIDs.
+
         Args:
-            security_groups: List of security group names or UUIDs
+        security_groups: List of security group names or UUIDs
         '''
         seclist = []
         all_groups = None
diff --git a/heat/engine/properties.py b/heat/engine/properties.py
index 1a0215dbf..5168ed002 100644
--- a/heat/engine/properties.py
+++ b/heat/engine/properties.py
@@ -471,8 +471,7 @@ class Properties(collections.Mapping):
 
     @classmethod
     def schema_to_parameters_and_properties(cls, schema):
-
-        '''Generates properties with params resolved for a resource's
+        """Generates properties with params resolved for a resource's
         properties_schema.
 
         :param schema: A resource type's properties_schema
@@ -487,7 +486,8 @@ class Properties(collections.Mapping):
                      'bar': {'Type': 'Json'}},
                     {'foo': {'Fn::Split': {'Ref': 'foo'}},
                      'bar': {'Ref': 'bar'}}
-        '''
+
+        """
         def param_prop_def_items(name, schema):
             param_def = cls._param_def_from_prop(schema)
             prop_def = cls._prop_def_from_prop(name, schema)