Cleanup more Sphinx warnings during doc build

This is a second pass at cleaning up Sphinx issues with the doc build.
These ones only show themselves on a full rebuild after you blow away
doc/build/* so they weren't always seen.

Change-Id: I44e39b7e1f2bcf7a5eb420dee1569eb0b84929a4

doc/source/users/guides/cluster/policy.rst

@@ -27,7 +27,7 @@ List Policies
 To examine the list of policies:
 
 .. literalinclude:: ../../examples/cluster/policy.py
-   :pyobject: list_policys
+   :pyobject: list_policies
 
 When listing policies, you can specify the sorting option using the ``sort``
 parameter and you can do pagination using the ``limit`` and ``marker``

doc/source/users/guides/cluster/policy_type.rst

@@ -42,4 +42,4 @@ it.
 
 Full example: `manage policy type`_
 
-.. _manage profile type: http://git.openstack.org/cgit/openstack/python-openstacksdk/tree/examples/cluster/policy_type.py
+.. _manage policy type: http://git.openstack.org/cgit/openstack/python-openstacksdk/tree/examples/cluster/policy_type.py

doc/source/users/guides/connect_from_config.rst

@@ -36,9 +36,9 @@ function takes three optional arguments:
 
 * **cloud_name** allows you to specify a cloud from your ``clouds.yaml`` file.
 * **cloud_config** allows you to pass in an existing
-``os_client_config.config.OpenStackConfig``` object.
+  ``os_client_config.config.OpenStackConfig``` object.
 * **options** allows you to specify a namespace object with options to be
-added to the cloud config.
+  added to the cloud config.
 
 .. literalinclude:: ../examples/connect.py
    :pyobject: Opts

doc/source/users/guides/network.rst

@@ -77,7 +77,7 @@ provide external network access for servers on project networks.
 Full example: `network resource list`_
 
 List Network Agents
-------------
+-------------------
 
 A **network agent** is a plugin that handles various tasks used to
 implement virtual networks.  These agents include neutron-dhcp-agent,

doc/source/users/resources/network/v2/auto_allocated_topology.rst

@@ -8,5 +8,5 @@ The Auto Allocated Topology Class
 
 The ``Auto Allocated Toplogy`` class inherits from :class:`~openstack.resource.Resource`.
 
-.. autoclass:: openstack.network.v2.auto_allocated_topology:AutoAllocatedTopology
+.. autoclass:: openstack.network.v2.auto_allocated_topology.AutoAllocatedTopology
    :members:

doc/source/users/resources/network/v2/network_ip_availability.rst

@@ -1,5 +1,5 @@
 openstack.network.v2.network_ip_availability
-===========================================
+============================================
 
 .. automodule:: openstack.network.v2.network_ip_availability
 

doc/source/users/resources/workflow/v2/execution.rst

@@ -8,5 +8,5 @@ The Execution Class
 
 The ``Execution`` class inherits from :class:`~openstack.resource.Resource`.
 
-.. autoclass:: openstack.workflow.v2.execution
+.. autoclass:: openstack.workflow.v2.execution.Execution
    :members:

doc/source/users/resources/workflow/v2/workflow.rst

@@ -8,5 +8,5 @@ The Workflow Class
 
 The ``Workflow`` class inherits from :class:`~openstack.resource.Resource`.
 
-.. autoclass:: openstack.workflow.v2.workflow
+.. autoclass:: openstack.workflow.v2.workflow.Workflow
    :members:

openstack/cluster/v1/_proxy.py

@@ -297,6 +297,7 @@ class Proxy(proxy2.BaseProxy):
         :param nodes: List of nodes to be removed from the cluster.
         :param kwargs \*\*params: Optional query parameters to be sent to
             restrict the nodes to be returned. Available parameters include:
+
             * destroy_after_deletion: A boolean value indicating whether the
                                       deleted nodes to be destroyed right away.
         :returns: A dict containing the action initiated by this operation.
@@ -709,6 +710,7 @@ class Proxy(proxy2.BaseProxy):
             :class:`~openstack.cluster.v1.cluster.Cluster` instance.
         :param kwargs \*\*query: Optional query parameters to be sent to
             restrict the policies to be returned. Available parameters include:
+
             * enabled: A boolean value indicating whether the policy is
                        enabled on the cluster.
         :returns: A generator of cluster-policy binding instances.

openstack/connection.py

@@ -276,10 +276,10 @@ class Connection(object):
 
         :returns: A string token.
 
-        :raises:`~openstack.exceptions.HttpException` if the authorization
+        :raises: :class:`~openstack.exceptions.HttpException` if the
-                fails due to reasons like the credentials provided are unable
+                 authorization fails due to reasons like the credentials
-                to be authorized or the `auth_plugin` argument is missing,
+                 provided are unable to be authorized or the `auth_plugin`
-                etc.
+                 argument is missing, etc.
         """
         headers = self.session.get_auth_headers()
 

openstack/network/v2/_proxy.py

@@ -154,7 +154,7 @@ class Proxy(proxy2.BaseProxy):
                         running on.
             * ``topic``: The message queue topic used.
             * ``is_admin_state_up``: The administrative state of the agent.
-            : ``is_alive``: Whether the agent is alive.
+            * ``is_alive``: Whether the agent is alive.
 
         :returns: A generator of agents
         :rtype: :class:`~openstack.network.v2.agent.Agent`
@@ -2662,9 +2662,8 @@ class Proxy(proxy2.BaseProxy):
         """Get a single network service flavor profile
 
         :param service_profile: The value can be the ID of a service_profile or
-                                a
+            a :class:`~openstack.network.v2.service_profile.ServiceProfile`
-                       :class:`~openstack.network.v2.service_profile
+            instance.
-                       .ServiceProfile` instance.
 
         :returns: One :class:`~openstack.network.v2.service_profile
                       .ServiceProfile`

openstack/network/v2/router.py

@@ -80,7 +80,7 @@ class Router(resource.Resource):
 
         :param session: The session to communicate through.
         :type session: :class:`~openstack.session.Session`
-        :param dict body : The body requested to be updated on the outer
+        :param dict body: The body requested to be updated on the router
 
         :returns: The body of the response as a dictionary.
         """
@@ -93,7 +93,7 @@ class Router(resource.Resource):
 
         :param session: The session to communicate through.
         :type session: :class:`~openstack.session.Session`
-        :param dict body : The body requested to be updated on the outer
+        :param dict body: The body requested to be updated on the router
 
         :returns: The body of the response as a dictionary.
         """
@@ -106,7 +106,7 @@ class Router(resource.Resource):
 
         :param session: The session to communicate through.
         :type session: :class:`~openstack.session.Session`
-        :param dict body : The body requested to be updated on the outer
+        :param dict body: The body requested to be updated on the router
 
         :returns: The body of the response as a dictionary.
         """
@@ -120,7 +120,7 @@ class Router(resource.Resource):
 
         :param session: The session to communicate through.
         :type session: :class:`~openstack.session.Session`
-        :param dict body : The body requested to be updated on the outer
+        :param dict body: The body requested to be updated on the router
 
         :returns: The body of the response as a dictionary.
         """

openstack/orchestration/v1/_proxy.py

@@ -168,8 +168,8 @@ class Proxy(proxy2.BaseProxy):
         :param dict query: Optional query parameters to be sent to limit the
                            software configs returned.
         :returns: A generator of software config objects.
-        :rtype:
+        :rtype: :class:`~openstack.orchestration.v1.software_config.\
-        :class:`~openstack.orchestration.v1.software_config.SoftwareConfig`
+                SoftwareConfig`
         """
         return self._list(_sc.SoftwareConfig, paginated=True, **query)
 
@@ -220,8 +220,8 @@ class Proxy(proxy2.BaseProxy):
         :param dict query: Optional query parameters to be sent to limit the
                            software deployments returned.
         :returns: A generator of software deployment objects.
-        :rtype:
+        :rtype: :class:`~openstack.orchestration.v1.software_deployment.\
-        :class:`~openstack.orchestration.v1.software_deployment.SoftwareDeployment`
+                SoftwareDeployment`
         """
         return self._list(_sd.SoftwareDeployment, paginated=False, **query)
 
@@ -263,8 +263,8 @@ class Proxy(proxy2.BaseProxy):
                            represented by ``software_deployment``.
 
         :returns: The updated software deployment
-        :rtype:
+        :rtype: :class:`~openstack.orchestration.v1.software_deployment.\
-        :class:`~openstack.orchestration.v1.software_deployment.SoftwareDeployment`
+                SoftwareDeployment`
         """
         return self._update(_sd.SoftwareDeployment, software_deployment,
                             **attrs)