.. T-RECS documentation master file, created by
   sphinx-quickstart on Mon Feb  3 10:02:24 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Simulator Documentation
============================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   readme

   reference/reference

Known bugs and inconsistencies
================================
Please check the `First Round`_ milestone for issues signaling bugs and limitation.

.. _First Round: https://github.com/elucherini/t-recs/milestone/3

Feedback and contributions
===========================
Feedback of any form is welcome. I especially encourage:

- Contributions to the code -- bug fixes, improvements, new features, etc. Feel free to send in `pull requests`_.
- "Bug reports" through the `GitHub issues`_ feature. Please try to explain the issue in as much detail as possible and I'll respond asap.
- Questions regarding the use of the tool.
- Corrections and fixes to these docs.
- General feedback about the tool. Is it useful to you? Is it easy to use? What would improve it?

.. _pull requests: https://github.com/elucherini/t-recs/pulls
.. _GitHub issues: https://github.com/elucherini/t-recs/milestone/3

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

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