Add base doc files

This commit is contained in:
Antonin RAFFIN
2018-09-15 15:04:02 +02:00
parent 8f3023816f
commit 796d0bddd9
10 changed files with 564 additions and 0 deletions

47
docs/index.rst Normal file
View File

@@ -0,0 +1,47 @@
.. PythonRobotics documentation master file, created by
sphinx-quickstart on Sat Sep 15 13:15:55 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to PythonRobotics's documentation!
==========================================
Python codes for robotics algorithm.
This is a Python code collection of robotics algorithms, especially for autonomous navigation.
Features:
1. Easy to read for understanding each algorithm's basic idea.
2. Widely used and practical algorithms are selected.
3. Minimum dependency.
See this paper for more details:
- `[1808.10703] PythonRobotics: a Python code collection of robotics
algorithms`_ (`BibTeX`_)
.. _`[1808.10703] PythonRobotics: a Python code collection of robotics algorithms`: https://arxiv.org/abs/1808.10703
.. _BibTeX: https://github.com/AtsushiSakai/PythonRoboticsPaper/blob/master/python_robotics.bib
.. toctree::
:maxdepth: 2
:caption: Guide
getting_started
modules/localization
modules/mapping
modules/slam
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`