Documentation
*************

Adding Documentation
--------------------

We are using Sphinx with RTD theme to display documentation. Adding documentation requires the following steps:

* Add a file with `.rst` suffix in the docs folder OR expand documentation in one of the `rst` files.
* Make sure its referenced in `index.rst`

Handy tools
-----------

Editing `rst` files in vs-code with the usage of `RST Preview`. This allows to see a preview of the output.


Quick guide to rst
------------------

Headings can be added by using asterisk `*******` underneath the heading. The amount of asterisks must fully cover the length of the heading-word.
Example:

.. code-block::

    Heading
    *******

Subsections can be added by using dashes `------`.
Example:

.. code-block::

    Subsections
    -----------

(un)-numbered items can be added using `*` or `#.`
Example:

.. code-block::

    * un-numbered bullet 1
    * un-numbered bullet 2

    #. numbered bullet 1
    #. numbered bullet 2

results in:

* un-numbered bullet 1
* un-numbered bullet 2

#. numbered bullet 1
#. numbered bullet 2


Reference:
^^^^^^^^^^

For further documentation, please refer to https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html