Merge pull request #13 from bimpression/docs

docs
sosw · Jan 25, 2019 · d89bf67 · d89bf67
2 parents 9840b7c + 3797a1b
commit d89bf67
Show file tree

Hide file tree

Showing 5 changed files with 93 additions and 0 deletions.
diff --git a/docs/components.rst b/docs/components.rst
@@ -0,0 +1,56 @@
+==========
+Components
+==========
+
+.. _components-config:
+
+Config Source
+-----------
+
+.. automodule:: sosw.components.config
+   :members:
+
+
+.. _components-helpers:
+
+Helpers
+-------
+
+.. automodule:: sosw.components.helpers
+   :members:
+
+
+.. _components-dynamo_db:
+
+DynamoDB Client
+---------------
+
+.. automodule:: sosw.components.dynamo_db
+   :members:
+
+
+.. _components-siblings:
+
+Siblings
+--------
+
+.. automodule:: sosw.components.siblings
+   :members:
+
+
+.. _components-sns:
+
+SNS Manager
+-----------
+
+.. automodule:: sosw.components.sns
+   :members:
+
+
+.. _components-tasks_api_client_for_workers:
+
+tasks_api_client_for_workers
+----------------------------
+
+.. automodule:: sosw.components.tasks_api_client_for_workers
+   :members:
diff --git a/docs/index.rst b/docs/index.rst
@@ -9,6 +9,15 @@ The three main components are Worker, Orchestrator and Scheduler.
 
 Documentation is on the way full speed, for now you can read informative docstrings...
 
+.. toctree::
+   :titlesonly:
+   :caption: Contents:
+
+   convention
+   ../sosw/components/docs/index
+   processor
+   worker
+
 
 Indices and tables
 ==================

diff --git a/docs/orchestrator.rst b/docs/orchestrator.rst
@@ -0,0 +1,9 @@
+Worker
+------
+
+Worker should be used as parent class for your Lambda processors in your workers.
+It has all the common methods of `sosw.app.Processor` and tries to close task in case it received some
+`task_id` in the payload (event).
+
+.. automodule:: sosw.worker
+   :members:
diff --git a/docs/processor.rst b/docs/processor.rst
@@ -0,0 +1,10 @@
+Orchestrator
+------------
+
+| Orchestrator does the ... Orchestration.
+| You can use the class in your Lambda as is, just configure some settings using one of the supported ways
+in * :ref:`Config <components-config>`
+
+
+.. automodule:: sosw.orchestrator
+   :members:
diff --git a/docs/worker.rst b/docs/worker.rst
@@ -0,0 +1,9 @@
+Worker
+------
+
+Worker should be used as parent class for your Lambda processors in your workers.
+It has all the common methods of `sosw.app.Processor` and tries to close task in case it received some
+`task_id` in the payload (event).
+
+.. automodule:: sosw.worker
+   :members: