Add docs for the worker based engine (WBE)

Begin to rework the twiki docs into a developer doc,
moving items from the twiki to rst and adjusting examples
to make a unified place where the worker model can be
documented.

Change-Id: I43ed828be33351b9fb6606317011e7204f61a136

1 files changed, 14 insertions, 0 deletions

diff --git a/taskflow/engines/worker_based/engine.py b/taskflow/engines/worker_based/engine.py
index af178cb..0c7702e 100644
--- a/taskflow/engines/worker_based/engine.py
+++ b/taskflow/engines/worker_based/engine.py
@@ -20,6 +20,20 @@ from taskflow import storage as t_storage
 
 
 class WorkerBasedActionEngine(engine.ActionEngine):
+    """Worker based action engine.
+
+    Specific backend configuration:
+
+    :param exchange: broker exchange exchange name in which executor / worker
+                     communication is performed
+    :param url: broker connection url (see format in kombu documentation)
+    :param topics: list of workers topics to communicate with (this will also
+                   be learned by listening to the notifications that workers
+                   emit).
+    :keyword transport: transport to be used (e.g. amqp, memory, etc.)
+    :keyword transport_options: transport specific options
+    """
+
     _storage_cls = t_storage.SingleThreadedStorage
 
     def _task_executor_cls(self):