[fsm] made an abstraction of _FSMCallable

CONTRIBUTING.rst

@@ -123,6 +123,6 @@ Generate Documentation
 
 .. code-block::bash
 
-    $ sphinx-apidoc -f -o docs/source gabrieltool
+    $ SPHINX_APIDOC_OPTIONS=members,undoc-members,show-inheritance,inherited-members sphinx-apidoc -H gabrieltool API -f -o docs/source gabrieltool
     $ cd docs
-    $ make html
+    $ make html

docs/conf.py

@@ -80,6 +80,7 @@
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
 
+napoleon_include_init_with_doc = True
 
 # -- Options for HTML output -------------------------------------------
 
@@ -165,4 +166,4 @@
      'gabrieltool',
      'One line description of project.',
      'Miscellaneous'),
-]
+]

docs/source/gabrieltool.rst

@@ -16,3 +16,4 @@ Module contents
    :members:
    :undoc-members:
    :show-inheritance:
+   :inherited-members:

docs/source/gabrieltool.statemachine.callable_zoo.processor_zoo.rst

@@ -0,0 +1,42 @@
+gabrieltool.statemachine.callable\_zoo.processor\_zoo package
+=============================================================
+
+Submodules
+----------
+
+gabrieltool.statemachine.callable\_zoo.processor\_zoo.base module
+-----------------------------------------------------------------
+
+.. automodule:: gabrieltool.statemachine.callable_zoo.processor_zoo.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+
+gabrieltool.statemachine.callable\_zoo.processor\_zoo.containerized module
+--------------------------------------------------------------------------
+
+.. automodule:: gabrieltool.statemachine.callable_zoo.processor_zoo.containerized
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+
+gabrieltool.statemachine.callable\_zoo.processor\_zoo.tfutils module
+--------------------------------------------------------------------
+
+.. automodule:: gabrieltool.statemachine.callable_zoo.processor_zoo.tfutils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+
+
+Module contents
+---------------
+
+.. automodule:: gabrieltool.statemachine.callable_zoo.processor_zoo
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:

docs/source/gabrieltool.statemachine.callable_zoo.rst

@@ -0,0 +1,32 @@
+gabrieltool.statemachine.callable\_zoo package
+==============================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   gabrieltool.statemachine.callable_zoo.processor_zoo
+
+Submodules
+----------
+
+gabrieltool.statemachine.callable\_zoo.predicate\_zoo module
+------------------------------------------------------------
+
+.. automodule:: gabrieltool.statemachine.callable_zoo.predicate_zoo
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+
+
+Module contents
+---------------
+
+.. automodule:: gabrieltool.statemachine.callable_zoo
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:

docs/source/gabrieltool.statemachine.rst

@@ -7,7 +7,7 @@ Subpackages
 .. toctree::
    :maxdepth: 4
 
-   gabrieltool.statemachine.processor_zoo
+   gabrieltool.statemachine.callable_zoo
 
 Submodules
 ----------
@@ -19,6 +19,7 @@ gabrieltool.statemachine.fsm module
    :members:
    :undoc-members:
    :show-inheritance:
+   :inherited-members:
 
 gabrieltool.statemachine.instruction\_pb2 module
 ------------------------------------------------
@@ -27,14 +28,7 @@ gabrieltool.statemachine.instruction\_pb2 module
    :members:
    :undoc-members:
    :show-inheritance:
-
-gabrieltool.statemachine.predicate\_zoo module
-----------------------------------------------
-
-.. automodule:: gabrieltool.statemachine.predicate_zoo
-   :members:
-   :undoc-members:
-   :show-inheritance:
+   :inherited-members:
 
 gabrieltool.statemachine.runner module
 --------------------------------------
@@ -43,6 +37,7 @@ gabrieltool.statemachine.runner module
    :members:
    :undoc-members:
    :show-inheritance:
+   :inherited-members:
 
 gabrieltool.statemachine.wca\_state\_machine\_pb2 module
 --------------------------------------------------------
@@ -51,6 +46,7 @@ gabrieltool.statemachine.wca\_state\_machine\_pb2 module
    :members:
    :undoc-members:
    :show-inheritance:
+   :inherited-members:
 
 
 Module contents
@@ -60,3 +56,4 @@ Module contents
    :members:
    :undoc-members:
    :show-inheritance:
+   :inherited-members:

gabrieltool/__init__.py

@@ -1 +1,3 @@
+"""Gabrieltool is a set of tools and libraries for fast prototyping wearable cognitive assistants.
+"""
 __version__ = '0.0.9'

gabrieltool/statemachine/__init__.py

@@ -0,0 +1,4 @@
+"""Library to build application logic as a Finite State Machine.
+"""
+
+from gabrieltool.statemachine.callable_zoo import processor_zoo, predicate_zoo  # noqa: F401