Commit 4a237c6c authored by Moritz Klischat's avatar Moritz Klischat

updated documentation

parent 4ab296e5
......@@ -49,7 +49,7 @@
<a href="../../commonroad_search.html" class="icon icon-home"> commonroad_search
<a href="../../index.html" class="icon icon-home"> commonroad_search
......@@ -150,7 +150,7 @@
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../commonroad_search.html">commonroad_search</a>
<a href="../../index.html">commonroad_search</a>
</nav>
......@@ -179,7 +179,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../../commonroad_search.html">Docs</a> &raquo;</li>
<li><a href="../../index.html">Docs</a> &raquo;</li>
<li><a href="../index.html">Module code</a> &raquo;</li>
......
......@@ -49,7 +49,7 @@
<a href="../../commonroad_search.html" class="icon icon-home"> commonroad_search
<a href="../../index.html" class="icon icon-home"> commonroad_search
......@@ -150,7 +150,7 @@
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../commonroad_search.html">commonroad_search</a>
<a href="../../index.html">commonroad_search</a>
</nav>
......@@ -179,7 +179,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../../commonroad_search.html">Docs</a> &raquo;</li>
<li><a href="../../index.html">Docs</a> &raquo;</li>
<li><a href="../index.html">Module code</a> &raquo;</li>
......
......@@ -49,7 +49,7 @@
<a href="../../commonroad_search.html" class="icon icon-home"> commonroad_search
<a href="../../index.html" class="icon icon-home"> commonroad_search
......@@ -150,7 +150,7 @@
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../commonroad_search.html">commonroad_search</a>
<a href="../../index.html">commonroad_search</a>
</nav>
......@@ -179,7 +179,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../../commonroad_search.html">Docs</a> &raquo;</li>
<li><a href="../../index.html">Docs</a> &raquo;</li>
<li><a href="../index.html">Module code</a> &raquo;</li>
......
......@@ -49,7 +49,7 @@
<a href="../../commonroad_search.html" class="icon icon-home"> commonroad_search
<a href="../../index.html" class="icon icon-home"> commonroad_search
......@@ -150,7 +150,7 @@
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../commonroad_search.html">commonroad_search</a>
<a href="../../index.html">commonroad_search</a>
</nav>
......@@ -179,7 +179,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../../commonroad_search.html">Docs</a> &raquo;</li>
<li><a href="../../index.html">Docs</a> &raquo;</li>
<li><a href="../index.html">Module code</a> &raquo;</li>
......
......@@ -49,7 +49,7 @@
<a href="../../commonroad_search.html" class="icon icon-home"> commonroad_search
<a href="../../index.html" class="icon icon-home"> commonroad_search
......@@ -150,7 +150,7 @@
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../commonroad_search.html">commonroad_search</a>
<a href="../../index.html">commonroad_search</a>
</nav>
......@@ -179,7 +179,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../../commonroad_search.html">Docs</a> &raquo;</li>
<li><a href="../../index.html">Docs</a> &raquo;</li>
<li><a href="../index.html">Module code</a> &raquo;</li>
......
......@@ -49,7 +49,7 @@
<a href="../../commonroad_search.html" class="icon icon-home"> commonroad_search
<a href="../../index.html" class="icon icon-home"> commonroad_search
......@@ -150,7 +150,7 @@
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../commonroad_search.html">commonroad_search</a>
<a href="../../index.html">commonroad_search</a>
</nav>
......@@ -179,7 +179,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../../commonroad_search.html">Docs</a> &raquo;</li>
<li><a href="../../index.html">Docs</a> &raquo;</li>
<li><a href="../index.html">Module code</a> &raquo;</li>
......
......@@ -49,7 +49,7 @@
<a href="../commonroad_search.html" class="icon icon-home"> commonroad_search
<a href="../index.html" class="icon icon-home"> commonroad_search
......@@ -150,7 +150,7 @@
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../commonroad_search.html">commonroad_search</a>
<a href="../index.html">commonroad_search</a>
</nav>
......@@ -179,7 +179,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../commonroad_search.html">Docs</a> &raquo;</li>
<li><a href="../index.html">Docs</a> &raquo;</li>
<li>Overview: module code</li>
......
.. commonroad-search documentation master file, created by
sphinx-quickstart on Fri May 3 14:12:41 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
=====================================
commonroad_search Documentation
=====================================
Finding safe motions in complex traffic situation is one of the major challenges in autonomous driving. Typically, one has to develop a large software framework before one can start developing new motion planning techniques---such a framework typically includes software for representing a road network, reasoning on such a network, collision checking, simulating vehicle dynamics, and visualizing results, to name only a few aspects. All this is taken care of by our CommonRoad software framework available from https://commonroad.in.tum.de.
To further facilitate the use of CommonRoad, we have developed new helper functions that are tailored for the search algorithms. A special feature of the CommonRoad website is that you can upload your solutions and see how well you perform to other groups.
User manual
=============================================
.. toctree::
:maxdepth: 2
:caption: Contents:
install/index.rst
api/index.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Contact information
===================
:Website: `http://commonroad.in.tum.de <https://commonroad.in.tum.de/>`_
:Email: `commonroad-i06@in.tum.de <commonroad-i06@in.tum.de>`_
......@@ -51,7 +51,7 @@
<a href="../commonroad_search.html" class="icon icon-home"> commonroad_search
<a href="../index.html" class="icon icon-home"> commonroad_search
......@@ -152,7 +152,7 @@
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../commonroad_search.html">commonroad_search</a>
<a href="../index.html">commonroad_search</a>
</nav>
......@@ -181,7 +181,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../commonroad_search.html">Docs</a> &raquo;</li>
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="index.html">commonroad_search API</a> &raquo;</li>
......
......@@ -51,7 +51,7 @@
<a href="../commonroad_search.html" class="icon icon-home"> commonroad_search
<a href="../index.html" class="icon icon-home"> commonroad_search
......@@ -152,7 +152,7 @@
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../commonroad_search.html">commonroad_search</a>
<a href="../index.html">commonroad_search</a>
</nav>
......@@ -181,7 +181,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../commonroad_search.html">Docs</a> &raquo;</li>
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="index.html">commonroad_search API</a> &raquo;</li>
......
......@@ -50,7 +50,7 @@
<a href="../commonroad_search.html" class="icon icon-home"> commonroad_search
<a href="../index.html" class="icon icon-home"> commonroad_search
......@@ -151,7 +151,7 @@
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../commonroad_search.html">commonroad_search</a>
<a href="../index.html">commonroad_search</a>
</nav>
......@@ -180,7 +180,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../commonroad_search.html">Docs</a> &raquo;</li>
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="index.html">commonroad_search API</a> &raquo;</li>
......
......@@ -51,7 +51,7 @@
<a href="../commonroad_search.html" class="icon icon-home"> commonroad_search
<a href="../index.html" class="icon icon-home"> commonroad_search
......@@ -152,7 +152,7 @@
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../commonroad_search.html">commonroad_search</a>
<a href="../index.html">commonroad_search</a>
</nav>
......@@ -181,7 +181,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../commonroad_search.html">Docs</a> &raquo;</li>
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="index.html">commonroad_search API</a> &raquo;</li>
......
......@@ -51,7 +51,7 @@
<a href="../commonroad_search.html" class="icon icon-home"> commonroad_search
<a href="../index.html" class="icon icon-home"> commonroad_search
......@@ -152,7 +152,7 @@
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../commonroad_search.html">commonroad_search</a>
<a href="../index.html">commonroad_search</a>
</nav>
......@@ -181,7 +181,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../commonroad_search.html">Docs</a> &raquo;</li>
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="index.html">commonroad_search API</a> &raquo;</li>
......
......@@ -51,7 +51,7 @@
<a href="../commonroad_search.html" class="icon icon-home"> commonroad_search
<a href="../index.html" class="icon icon-home"> commonroad_search
......@@ -152,7 +152,7 @@
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../commonroad_search.html">commonroad_search</a>
<a href="../index.html">commonroad_search</a>
</nav>
......@@ -181,7 +181,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../commonroad_search.html">Docs</a> &raquo;</li>
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="index.html">commonroad_search API</a> &raquo;</li>
......
......@@ -51,7 +51,7 @@
<a href="../commonroad_search.html" class="icon icon-home"> commonroad_search
<a href="../index.html" class="icon icon-home"> commonroad_search
......@@ -152,7 +152,7 @@
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../commonroad_search.html">commonroad_search</a>
<a href="../index.html">commonroad_search</a>
</nav>
......@@ -181,7 +181,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../commonroad_search.html">Docs</a> &raquo;</li>
<li><a href="../index.html">Docs</a> &raquo;</li>
<li>commonroad_search API</li>
......
......@@ -50,7 +50,7 @@
<a href="commonroad_search.html" class="icon icon-home"> commonroad_search
<a href="index.html" class="icon icon-home"> commonroad_search
......@@ -151,7 +151,7 @@
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="commonroad_search.html">commonroad_search</a>
<a href="index.html">commonroad_search</a>
</nav>
......@@ -180,7 +180,7 @@
<ul class="wy-breadcrumbs">
<li><a href="commonroad_search.html">Docs</a> &raquo;</li>
<li><a href="index.html">Docs</a> &raquo;</li>
<li>Index</li>
......
This diff is collapsed.
......@@ -37,7 +37,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="commonroad_search API" href="../api/index.html" />
<link rel="prev" title="commonroad_search Documentation" href="../commonroad_search.html" />
<link rel="prev" title="commonroad_search Documentation" href="../index.html" />
</head>
<body class="wy-body-for-nav">
......@@ -51,7 +51,7 @@
<a href="../commonroad_search.html" class="icon icon-home"> commonroad_search
<a href="../index.html" class="icon icon-home"> commonroad_search
......@@ -152,7 +152,7 @@
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../commonroad_search.html">commonroad_search</a>
<a href="../index.html">commonroad_search</a>
</nav>
......@@ -181,7 +181,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../commonroad_search.html">Docs</a> &raquo;</li>
<li><a href="../index.html">Docs</a> &raquo;</li>
<li>Installation</li>
......@@ -309,7 +309,7 @@
<a href="../api/index.html" class="btn btn-neutral float-right" title="commonroad_search API" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../commonroad_search.html" class="btn btn-neutral float-left" title="commonroad_search Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<a href="../index.html" class="btn btn-neutral float-left" title="commonroad_search Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
......
......@@ -52,7 +52,7 @@
<a href="commonroad_search.html" class="icon icon-home"> commonroad_search
<a href="index.html" class="icon icon-home"> commonroad_search
......@@ -153,7 +153,7 @@
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="commonroad_search.html">commonroad_search</a>
<a href="index.html">commonroad_search</a>
</nav>
......@@ -182,7 +182,7 @@
<ul class="wy-breadcrumbs">
<li><a href="commonroad_search.html">Docs</a> &raquo;</li>
<li><a href="index.html">Docs</a> &raquo;</li>
<li>Python Module Index</li>
......
......@@ -50,7 +50,7 @@
<a href="commonroad_search.html" class="icon icon-home"> commonroad_search
<a href="index.html" class="icon icon-home"> commonroad_search
......@@ -151,7 +151,7 @@
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="commonroad_search.html">commonroad_search</a>
<a href="index.html">commonroad_search</a>
</nav>
......@@ -180,7 +180,7 @@
<ul class="wy-breadcrumbs">
<li><a href="commonroad_search.html">Docs</a> &raquo;</li>
<li><a href="index.html">Docs</a> &raquo;</li>
<li>Search</li>
......
......@@ -61,7 +61,7 @@ templates_path = ['_templates']
source_suffix = '.rst'
# The master toctree document.
master_doc = 'commonroad_search'
master_doc = 'index'
# General information about the project.
project = 'commonroad_search'
......
.. commonroad-search documentation master file, created by
sphinx-quickstart on Fri May 3 14:12:41 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
=====================================
commonroad_search Documentation
=====================================
Finding safe motions in complex traffic situation is one of the major challenges in autonomous driving. Typically, one has to develop a large software framework before one can start developing new motion planning techniques---such a framework typically includes software for representing a road network, reasoning on such a network, collision checking, simulating vehicle dynamics, and visualizing results, to name only a few aspects. All this is taken care of by our CommonRoad software framework available from https://commonroad.in.tum.de.
To further facilitate the use of CommonRoad, we have developed new helper functions that are tailored for the search algorithms. A special feature of the CommonRoad website is that you can upload your solutions and see how well you perform to other groups.
User manual
=============================================
.. toctree::
:maxdepth: 2
:caption: Contents:
install/index.rst
api/index.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Contact information
===================
:Website: `http://commonroad.in.tum.de <https://commonroad.in.tum.de/>`_
:Email: `commonroad-i06@in.tum.de <commonroad-i06@in.tum.de>`_
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment