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
This commit is contained in:
Brian Curtin
parent
93894627ec
commit
adc2cb8904
|
|
@ -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``
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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,
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
openstack.network.v2.network_ip_availability
|
||||
===========================================
|
||||
============================================
|
||||
|
||||
.. automodule:: openstack.network.v2.network_ip_availability
|
||||
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -297,8 +297,9 @@ 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.
|
||||
deleted nodes to be destroyed right away.
|
||||
:returns: A dict containing the action initiated by this operation.
|
||||
"""
|
||||
if isinstance(cluster, _cluster.Cluster):
|
||||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -276,10 +276,10 @@ class Connection(object):
|
|||
|
||||
:returns: A string token.
|
||||
|
||||
:raises:`~openstack.exceptions.HttpException` if the authorization
|
||||
fails due to reasons like the credentials provided are unable
|
||||
to be authorized or the `auth_plugin` argument is missing,
|
||||
etc.
|
||||
:raises: :class:`~openstack.exceptions.HttpException` if the
|
||||
authorization fails due to reasons like the credentials
|
||||
provided are unable to be authorized or the `auth_plugin`
|
||||
argument is missing, etc.
|
||||
"""
|
||||
headers = self.session.get_auth_headers()
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
:class:`~openstack.network.v2.service_profile
|
||||
.ServiceProfile` instance.
|
||||
a :class:`~openstack.network.v2.service_profile.ServiceProfile`
|
||||
instance.
|
||||
|
||||
:returns: One :class:`~openstack.network.v2.service_profile
|
||||
.ServiceProfile`
|
||||
|
|
@ -2682,7 +2681,7 @@ class Proxy(proxy2.BaseProxy):
|
|||
* ``description``: The description of the service flavor profile
|
||||
* ``driver``: Provider driver for the service flavor profile
|
||||
* ``is_enabled``: Whether the profile is enabled
|
||||
* ``project_id``: The owner project ID
|
||||
* ``project_id``: The owner project ID
|
||||
|
||||
:returns: A generator of service profile objects
|
||||
:rtype: :class:`~openstack.network.v2.service_profile.ServiceProfile`
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
"""
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
:class:`~openstack.orchestration.v1.software_config.SoftwareConfig`
|
||||
:rtype: :class:`~openstack.orchestration.v1.software_config.\
|
||||
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:
|
||||
:class:`~openstack.orchestration.v1.software_deployment.SoftwareDeployment`
|
||||
:rtype: :class:`~openstack.orchestration.v1.software_deployment.\
|
||||
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:
|
||||
:class:`~openstack.orchestration.v1.software_deployment.SoftwareDeployment`
|
||||
:rtype: :class:`~openstack.orchestration.v1.software_deployment.\
|
||||
SoftwareDeployment`
|
||||
"""
|
||||
return self._update(_sd.SoftwareDeployment, software_deployment,
|
||||
**attrs)
|
||||
|
|
|
|||
Loading…
Reference in New Issue