Update Subnet Pools Documentation

rtheis · rtheis · commit 12aa63e65a38 · 2016-01-08T15:30:19.000-06:00
Update documentation for the SubnetPools resource. This includes adding
the resource to the users documentation and fixing broken links in the
network proxy documentation.

Change-Id: I0c5b51af81bd01cd74da682e70b8bf421a87d19d
Partial-Bug: #1528669
diff --git a/doc/source/users/resources/network/index.rst b/doc/source/users/resources/network/index.rst
@@ -20,3 +20,4 @@ Network Resources
    v2/security_group
    v2/security_group_rule
    v2/subnet
+   v2/subnet_pool
diff --git a/doc/source/users/resources/network/v2/subnet_pool.rst b/doc/source/users/resources/network/v2/subnet_pool.rst
@@ -0,0 +1,12 @@
+openstack.network.v2.subnet_pool
+================================
+
+.. automodule:: openstack.network.v2.subnet_pool
+
+The SubnetPool Class
+--------------------
+
+The ``SubnetPool`` class inherits from :class:`~openstack.resource.Resource`.
+
+.. autoclass:: openstack.network.v2.subnet_pool.SubnetPool
+   :members:
diff --git a/openstack/network/v2/_proxy.py b/openstack/network/v2/_proxy.py
@@ -1337,9 +1337,8 @@ def create_subnet_pool(self, **attrs):
         """Create a new subnet pool from attributes
 
         :param dict attrs: Keyword arguments which will be used to create
-                           a :class:`~openstack.network.v2.subnet_pool.
-                           SubnetPool`, comprised of the properties on the
-                           SubnetPool class.
+            a :class:`~openstack.network.v2.subnet_pool.SubnetPool`,
+            comprised of the properties on the SubnetPool class.
 
         :returns: The results of subnet pool creation
         :rtype: :class:`~openstack.network.v2.subnet_pool.SubnetPool`
@@ -1350,8 +1349,7 @@ def delete_subnet_pool(self, subnet_pool, ignore_missing=True):
         """Delete a subnet pool
 
         :param subnet_pool: The value can be either the ID of a subnet pool or
-                            a :class:`~openstack.network.v2.subnet_pool.
-                            SubnetPool` instance.
+            a :class:`~openstack.network.v2.subnet_pool.SubnetPool` instance.
         :param bool ignore_missing: When set to ``False``
                     :class:`~openstack.exceptions.ResourceNotFound` will be
                     raised when the subnet pool does not exist.
@@ -1382,8 +1380,7 @@ def get_subnet_pool(self, subnet_pool):
         """Get a single subnet pool
 
         :param subnet_pool: The value can be the ID of a subnet pool or a
-                            :class:`~openstack.network.v2.subnet_pool.
-                            SubnetPool` instance.
+            :class:`~openstack.network.v2.subnet_pool.SubnetPool` instance.
 
         :returns: One :class:`~openstack.network.v2.subnet_pool.SubnetPool`
         :raises: :class:`~openstack.exceptions.ResourceNotFound`
@@ -1406,8 +1403,7 @@ def update_subnet_pool(self, subnet_pool, **attrs):
         """Update a subnet pool
 
         :param subnet_pool: Either the ID of a subnet pool or a
-                            :class:`~openstack.network.v2.subnet_pool.
-                            SubnetPool` instance.
+            :class:`~openstack.network.v2.subnet_pool.SubnetPool` instance.
         :attrs kwargs: The attributes to update on the subnet pool
                        represented by ``value``.
 
