Joshua Harlow 95e94f768a Include documentation of the utility modules

Add a documentation section that uses the automodule
sphinx documentation generator to build a utility page
that shows people what the utility modules taskflow
uses for *internal* usage are and include a warning to
try to avoid end-users from using these modules (better
to warn than not warn).

This also adds on docstrings to various functions that
were missing it so that they appear correctly in the
generated documentation.

Change-Id: Ibd5695927601614f31793ea5450887694f4320ae

2014-11-28 13:07:38 -08:00

788 B

Raw Blame History

Utilities

Warning

External usage of internal utility functions and modules should be kept to a minimum as they may be altered, refactored or moved to other locations without notice (and without the typical deprecation cycle).

Async

taskflow.utils.async_utils

Deprecation

taskflow.utils.deprecation

Kazoo

taskflow.utils.kazoo_utils

Locks

taskflow.utils.lock_utils

Miscellaneous

taskflow.utils.misc

Persistence

taskflow.utils.persistence_utils

Reflection

taskflow.utils.reflection

Threading

taskflow.utils.threading_utils

788 B Raw Blame History