Development
===========

Build the documentation locally
-------------------------------

Install the package and documentation requirements:

.. code-block:: bash

   pip install -e .
   pip install -r docs/requirements.txt

Build the HTML documentation:

.. code-block:: bash

   sphinx-build -b html docs docs/_build/html

Documentation style
-------------------

Public classes, methods and functions should include docstrings that explain:

* what the function does
* parameter meaning and accepted value ranges
* return value
* side effects, especially Bluetooth connections or cached state updates

The Sphinx configuration supports Google-style and NumPy-style docstrings through ``sphinx.ext.napoleon``.