.. highway-env documentation master file, created by
   sphinx-quickstart on Wed Feb 28 15:51:44 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


.. |Build Status| image:: https://github.com/eleurent/highway-env/workflows/build/badge.svg
   :target: https://github.com/eleurent/highway-env/workflows/build/

.. |Documentation Status| image:: https://readthedocs.org/projects/highway-env/badge/?version=latest
   :target: https://highway-env.readthedocs.io/en/latest/

.. |Codacy Status| image:: https://api.codacy.com/project/badge/Grade/63847d9328f64fce9c137b03fcafcc27
  :target: https://app.codacy.com/manual/eleurent/highway-env?utm_source=github.com&utm_medium=referral&utm_content=eleurent/highway-env&utm_campaign=Badge_Grade_Dashboard

.. |Coverage Status| image:: https://codecov.io/gh/eleurent/highway-env/branch/master/graph/badge.svg
  :target: https://codecov.io/gh/eleurent/highway-env

.. |Contributors| image:: https://img.shields.io/github/contributors/eleurent/highway-env
  :target: https://github.com/eleurent/highway-env/graphs/contributors

.. |Environments| image:: https://img.shields.io/github/search/eleurent/highway-env/import%20filename:*_env%20path:highway_env/envs?label=environments
  :target: https://highway-env.readthedocs.io/en/latest/quickstart.html#all-the-environments


|Build Status| |Documentation Status| |Codacy Status| |Coverage Status| |Contributors| |Environments|

Welcome to `highway-env <https://github.com/eleurent/highway-env>`_'s documentation!
====================================================================================

This project gathers a collection of environment for *decision-making* in Autonomous Driving.

The purpose of this documentation is to provide:

1. a :ref:`quick start guide <quickstart>` describing the environments and their customization options;
2. a :ref:`detailed description <user_guide>` of the nuts and bolts of the project, and how *you* can contribute.

.. _index_how_to_cite_this_work:

How to cite this work?
======================

If you use this package, please consider citing it with this piece of
BibTeX:

.. code:: bibtex

  @misc{highway-env,
    author = {Leurent, Edouard},
    title = {An Environment for Autonomous Driving Decision-Making},
    year = {2018},
    publisher = {GitHub},
    journal = {GitHub repository},
    howpublished = {\url{https://github.com/eleurent/highway-env}},
  }

Documentation contents
======================

.. toctree::
  :maxdepth: 2

  installation
  quickstart
  user_guide
  bibliography/index