.. RecursiveRouteChoice documentation master file, created by
   sphinx-quickstart on Sat Sep 12 15:39:43 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. Note to me, use conda windows to build Sphinx

Documentation for RecursiveRouteChoice
======================================
RecursiveRouteChoice is an efficient  Python implementation of the recursive logit model for
route choice. It supports both both prediction and estimation. See Overview and Installation for
some more details.

..
    Put a readme in

.. toctree::
    :numbered:
    :maxdepth: 2
    :caption: Introduction & Overview:

    source/introduction_install
    source/simple_example
    source/involved_example
    source/data_formats


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

    apisource/recursiveRouteChoice
..
    apisource/modules

..
    api/data_loading
    api/data_processing
    api/optimisers
    api/recursive_route_choice



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

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