=====================================
Welcome to rNets' Documentation!
=====================================

.. include:: ../../README.rst
   :start-after: project-description-start
   :end-before: project-description-end


.. toctree::
   :maxdepth: 3
   :caption: Quick Start

   quick_start/installation
   quick_start/basic_usage
   quick_start/command_line_help
   quick_start/file_formats

.. toctree::
   :maxdepth: 3
   :caption: Examples

   examples/command_line
   examples/python_api
   examples/published_article

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

   api/rnets

.. toctree::
   :maxdepth: 2
   :caption: About

   about/developers
   about/citation
   about/contribution

License
-------

.. include:: ../../README.rst
   :start-after: project-license-start
   :end-before: project-license-end

Indices and tables
------------------

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