.. Jarvis UI documentation master file, created by
   sphinx-quickstart on Wed Jun 15 11:46:55 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Jarvis UI's documentation!
=====================================

.. toctree::
   :maxdepth: 2
   :caption: Read Me:

   README

Jarvis
====================

.. automodule:: jarvis_ui.main
   :members:
   :undoc-members:

Logger
======

.. automodule:: jarvis_ui.logger
   :members:
   :undoc-members:

Executables
===========

API Handler
===========

.. automodule:: jarvis_ui.executables.api_handler
   :members:
   :undoc-members:


Display
=======

.. automodule:: jarvis_ui.executables.display
   :members:
   :undoc-members:

Helper
======

.. automodule:: jarvis_ui.executables.helper
   :members:
   :undoc-members:

Listener
========

.. automodule:: jarvis_ui.executables.listener
   :members:
   :undoc-members:

Processor
=========

.. automodule:: jarvis_ui.executables.processor
   :members:
   :undoc-members:

Speaker
=======

.. automodule:: jarvis_ui.executables.speaker
   :members:
   :undoc-members:

Starter
=======

.. automodule:: jarvis_ui.executables.starter
   :members:
   :undoc-members:

Modules
=======

Config
======

.. autoclass:: jarvis_ui.modules.config.Config(BaseConfig)
   :members:
   :exclude-members:

Exceptions
==========

.. automodule:: jarvis_ui.modules.exceptions
   :members:
   :undoc-members:

Models
======

.. autoclass:: jarvis_ui.modules.models.EnvConfig(BaseSettings)
   :members:
   :undoc-members:

.. autoclass:: jarvis_ui.modules.models.FileIO(BaseSettings)
   :members:
   :undoc-members:

.. autoclass:: jarvis_ui.modules.models.Settings(BaseSettings)
   :members:
   :undoc-members:

.. autoclass:: jarvis_ui.modules.models.Sensitivity(float or PositiveInt, Enum)
   :members:
   :undoc-members:

Peripherals
===========

.. automodule:: jarvis_ui.modules.peripherals
   :members:
   :undoc-members:

Repeated Timer
==============

.. automodule:: jarvis_ui.modules.timer
   :members:
   :undoc-members:

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`