Documentation
===================================

.. _documentation:


The documentation was built with `Sphinx <https://www.sphinx-doc.org/en/master/>`_
and `Readthedocs <https://readthedocs.org/>`_.

The documentation source files are located in ``docs/source``.

In order to build the documentation locally, execute the following command in the ``docs/`` directory:

.. code-block:: bash

   make html

Clean the build directory with

.. code-block:: bash

   make clean 

Then push the changes to the Github repository and the documentation will be updated automatically.