Files
PythonRobotics/docs/index_main.rst
2025-01-25 23:30:14 +09:00

58 lines
1.6 KiB
ReStructuredText

.. 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. The project is on `GitHub`_.
This is a Python code collection of robotics algorithms.
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
.. _GitHub: https://github.com/AtsushiSakai/PythonRobotics
.. toctree::
:maxdepth: 2
:caption: Contents
getting_started
modules/1_introduction/introduction
modules/2_localization/localization
modules/3_mapping/mapping
modules/4_slam/slam
modules/5_path_planning/path_planning
modules/6_path_tracking/path_tracking
modules/7_arm_navigation/arm_navigation
modules/8_aerial_navigation/aerial_navigation
modules/9_bipedal/bipedal
modules/10_control/control
modules/11_utils/utils
modules/12_appendix/appendix
how_to_contribute
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`