openstack/deb-python-openstacksdk
Code Issues Proposed changes

Reorganize orchestration docs

Browse Source 
This change organizes the orchestration docs by topic rather than
letting autodoc organize methods by the order they appear in the
_proxy.py file.

Change-Id: Ia7df2887c0b1fa1d4eb04a9372dab247f21311a4
This commit is contained in:
Brian Curtin
2017-02-16 16:47:52 -05:00
parent 5ca2fa80ad
commit 693bdaf947
1 changed files with 34 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
doc/source/users/proxies/orchestration.rst
View File

@@ -13,5 +13,38 @@ The orchestration high-level interface is available through the
object. The ``orchestration`` member will only be added if the service
is detected.
Stack Operations
^^^^^^^^^^^^^^^^
.. autoclass:: openstack.orchestration.v1._proxy.Proxy
:members:
.. automethod:: openstack.orchestration.v1._proxy.Proxy.create_stack
.. automethod:: openstack.orchestration.v1._proxy.Proxy.check_stack
.. automethod:: openstack.orchestration.v1._proxy.Proxy.update_stack
.. automethod:: openstack.orchestration.v1._proxy.Proxy.delete_stack
.. automethod:: openstack.orchestration.v1._proxy.Proxy.find_stack
.. automethod:: openstack.orchestration.v1._proxy.Proxy.get_stack
.. automethod:: openstack.orchestration.v1._proxy.Proxy.stacks
.. automethod:: openstack.orchestration.v1._proxy.Proxy.validate_template
.. automethod:: openstack.orchestration.v1._proxy.Proxy.resources
Software Configuration Operations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.orchestration.v1._proxy.Proxy
.. automethod:: openstack.orchestration.v1._proxy.Proxy.create_software_config
.. automethod:: openstack.orchestration.v1._proxy.Proxy.delete_software_config
.. automethod:: openstack.orchestration.v1._proxy.Proxy.get_software_config
.. automethod:: openstack.orchestration.v1._proxy.Proxy.software_configs
Software Deployment Operations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.orchestration.v1._proxy.Proxy
.. automethod:: openstack.orchestration.v1._proxy.Proxy.create_software_deployment
.. automethod:: openstack.orchestration.v1._proxy.Proxy.update_software_deployment
.. automethod:: openstack.orchestration.v1._proxy.Proxy.delete_software_deployment
.. automethod:: openstack.orchestration.v1._proxy.Proxy.get_software_deployment
.. automethod:: openstack.orchestration.v1._proxy.Proxy.software_deployments