.. _documentation:


Document your code: Guidelines
===============================


In the development of this python library we use sphinx notation to document the modules, functions or classes docstrings.

Style Guidelines
----------------



Check the docs before opening a Pull Request
---------------------------------------------

Before submitting a pull request, check that documentation is generated by using:

.. code-block:: shell

    poetry run sphinx-build -b html docs/source docs/build