95e94f768a
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
50 lines
788 B
ReStructuredText
50 lines
788 B
ReStructuredText
---------
|
|
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
|
|
~~~~~
|
|
|
|
.. automodule:: taskflow.utils.async_utils
|
|
|
|
Deprecation
|
|
~~~~~~~~~~~
|
|
|
|
.. automodule:: taskflow.utils.deprecation
|
|
|
|
Kazoo
|
|
~~~~~
|
|
|
|
.. automodule:: taskflow.utils.kazoo_utils
|
|
|
|
Locks
|
|
~~~~~
|
|
|
|
.. automodule:: taskflow.utils.lock_utils
|
|
|
|
Miscellaneous
|
|
~~~~~~~~~~~~~
|
|
|
|
.. automodule:: taskflow.utils.misc
|
|
|
|
Persistence
|
|
~~~~~~~~~~~
|
|
|
|
.. automodule:: taskflow.utils.persistence_utils
|
|
|
|
Reflection
|
|
~~~~~~~~~~
|
|
|
|
.. automodule:: taskflow.utils.reflection
|
|
|
|
Threading
|
|
~~~~~~~~~
|
|
|
|
.. automodule:: taskflow.utils.threading_utils
|