mirror of
https://github.com/AtsushiSakai/PythonRobotics.git
synced 2026-04-22 03:00:22 -04:00
Add base doc files
This commit is contained in:
47
docs/index.rst
Normal file
47
docs/index.rst
Normal 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`
|
||||
Reference in New Issue
Block a user