API documentation
=================

The following documentation is based on the source code of version |release| of
the `coloredlogs` package.

The most useful entry points into the documentation are
:func:`~coloredlogs.install()`, :class:`~coloredlogs.ColoredFormatter` and
:func:`~coloredlogs.syslog.enable_system_logging()`.

The :mod:`coloredlogs` module
-----------------------------

.. automodule:: coloredlogs
   :members:

The :mod:`coloredlogs.converter` module
---------------------------------------

.. automodule:: coloredlogs.converter
   :members:

The :mod:`coloredlogs.syslog` module
------------------------------------

.. automodule:: coloredlogs.syslog
   :members: