.. br2 documentation master file, created by
   sphinx-quickstart on Wed Mar 16 17:11:27 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

*****************************
BR2 simulator's documentation
*****************************

.. badges

.. include:: intro.rst

Contributing
~~~~~~~~~~~~

This project is developed privately at this stage.


.. toctree::
   :maxdepth: 2
   :caption: How To

   guide/how_to_set_simulation
   guide/examples

.. toctree::
   :maxdepth: 2
   :caption: API

   api/simulator



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`