Documentation generation
========================

Documentation has been created by using module ``Sphinx``. You can install necessary requirements by executing
following command in the ``docs`` directory::

    python3 -m pip install -r requirements.txt


It can be generated by execution following command in the ``docs`` directory::

    make html

``index.html`` file with additional files has been created in the folder ``_build/html``.

Documentation also contains some tests. If you want to run them simply execute in the ``docs`` directory::

    make doctest


.. toctree::
    :maxdepth: 2