openstack/deb-python-openstacksdk
Code Issues Proposed changes

Reorganize workflow docs

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

Change-Id: I3f220829ae7039a38bf76dee59131fce11af95f0
This commit is contained in:
Brian Curtin
2017-02-28 10:46:00 -05:00
parent adfbf65c14
commit 1ddaa6bef9
1 changed files with 21 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
doc/source/users/proxies/workflow.rst
View File

@@ -1,7 +1,7 @@
Workflow API
============
For details on how to use block_store, see :doc:`/users/guides/block_store`
For details on how to use workflow, see :doc:`/users/guides/workflow`
.. automodule:: openstack.workflow.v2._proxy
@@ -12,5 +12,24 @@ The workflow high-level interface is available through the ``workflow``
member of a :class:`~openstack.connection.Connection` object.
The ``workflow`` member will only be added if the service is detected.
Workflow Operations
^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.workflow.v2._proxy.Proxy
:members:
.. automethod:: openstack.workflow.v2._proxy.Proxy.create_workflow
.. automethod:: openstack.workflow.v2._proxy.Proxy.delete_workflow
.. automethod:: openstack.workflow.v2._proxy.Proxy.get_workflow
.. automethod:: openstack.workflow.v2._proxy.Proxy.find_workflow
.. automethod:: openstack.workflow.v2._proxy.Proxy.workflows
Execution Operations
^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.workflow.v2._proxy.Proxy
.. automethod:: openstack.workflow.v2._proxy.Proxy.create_execution
.. automethod:: openstack.workflow.v2._proxy.Proxy.delete_execution
.. automethod:: openstack.workflow.v2._proxy.Proxy.get_execution
.. automethod:: openstack.workflow.v2._proxy.Proxy.find_execution
.. automethod:: openstack.workflow.v2._proxy.Proxy.executions