Currently job artifacts in CI/CD pipelines on LRZ GitLab never expire. Starting from Wed 26.1.2022 the default expiration time will be 30 days (GitLab default). Currently existing artifacts in already completed jobs will not be affected by the change. The latest artifacts for all jobs in the latest successful pipelines will be kept. More information: https://gitlab.lrz.de/help/user/admin_area/settings/continuous_integration.html#default-artifacts-expiration

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

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>
......
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>commonroad_search Documentation &mdash; commonroad_search 2019a documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Installation" href="install/index.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home"> commonroad_search
<img src="_static/commonroad_white150.png" class="logo" alt="Logo"/>
</a>
<div class="version">
2019a
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="install/index.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="install/index.html#hint">Hint</a></li>
<li class="toctree-l2"><a class="reference internal" href="install/index.html#setup-of-the-conda-environment">Setup of the conda environment</a></li>
<li class="toctree-l2"><a class="reference internal" href="install/index.html#how-to-install">How to install</a></li>
<li class="toctree-l2"><a class="reference internal" href="install/index.html#id1">1. CommonRoad_io</a></li>
<li class="toctree-l2"><a class="reference internal" href="install/index.html#id2">2. CommonRoad_Collision_Checker</a></li>
<li class="toctree-l2"><a class="reference internal" href="install/index.html#boundary">3. Boundary</a></li>
<li class="toctree-l2"><a class="reference internal" href="install/index.html#how-to-use">How to use</a></li>
<li class="toctree-l2"><a class="reference internal" href="install/index.html#implement-your-own-search-algorithm">Implement your own search algorithm</a></li>
<li class="toctree-l2"><a class="reference internal" href="install/index.html#trouble-shooting">Trouble Shooting</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/index.html">commonroad_search API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/index.html#modules">Modules</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/MotionPlanner.html">Module Motion Planner</a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/MotionPlanner.html#motion-planner">Motion Planner</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/MotionPlanner.html#priority-queue">Priority Queue</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/MotionPlanner.html#other-functions">Other Functions</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="api/MotionAutomata.html">Module Motion Automata</a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/MotionAutomata.html#module-Automata.MotionAutomata">Motion Automata</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="api/MotionPrimitiveParser.html">Module Motion Primitive Parser</a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/MotionPrimitiveParser.html#module-Automata.MotionPrimitiveParser">Motion Primitive Parser</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/MotionPrimitiveParser.html#other-functions">Other Functions</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="api/States.html">Module States</a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/States.html#module-Automata.States">Start State</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/States.html#final-state">Final State</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="api/TrajectoryParser.html">Module Trajectory Parser</a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/TrajectoryParser.html#module-Automata.TrajectoryParser">Trajectory</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/TrajectoryParser.html#trajectory-set">Trajectory Set</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/TrajectoryParser.html#trajectory-parser">Trajectory Parser</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="api/MotionPrimitive.html">Module Motion Primitive</a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/MotionPrimitive.html#module-Automata.MotionPrimitive">Motion Primitive</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">commonroad_search</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">