From 1ddaa6bef9467097cbd3f2b8ed76b8cb1e8a7995 Mon Sep 17 00:00:00 2001 From: Brian Curtin Date: Tue, 28 Feb 2017 10:46:00 -0500 Subject: [PATCH] Reorganize workflow docs 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 --- doc/source/users/proxies/workflow.rst | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/doc/source/users/proxies/workflow.rst b/doc/source/users/proxies/workflow.rst index 9fea0c46..5f8cbe5b 100644 --- a/doc/source/users/proxies/workflow.rst +++ b/doc/source/users/proxies/workflow.rst @@ -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