mirror of
https://github.com/AtsushiSakai/PythonRobotics.git
synced 2026-01-12 23:58:04 -05:00
67a3ca7138
* add state machine state_machine test state_machine_update * add state machine test/doc * state machine update * state machine generate_plantuml() can show diagram by using https://www.plantuml.com/plantuml/
58 lines
2.0 KiB
ReStructuredText
58 lines
2.0 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!
|
|
==========================================
|
|
|
|
"PythonRobotics" is a Python code collections and textbook
|
|
(This document) for robotics algorithm, which is developed on `GitHub`_.
|
|
|
|
See this section (:ref:`What is PythonRobotics?`) for more details of this project.
|
|
|
|
This project is `the one of the most popular open-source software (OSS) in
|
|
the field of robotics on GitHub`_.
|
|
This is `user comments about this project`_, and
|
|
this graph shows GitHub star history of this project:
|
|
|
|
.. image:: https://api.star-history.com/svg?repos=AtsushiSakai/PythonRobotics&type=Date
|
|
:alt: Star History
|
|
:width: 80%
|
|
:align: center
|
|
|
|
|
|
.. _GitHub: https://github.com/AtsushiSakai/PythonRobotics
|
|
.. _`user comments about this project`: https://github.com/AtsushiSakai/PythonRobotics/blob/master/users_comments.md
|
|
.. _`MIT license`: https://github.com/AtsushiSakai/PythonRobotics/blob/master/LICENSE
|
|
.. _`the one of the most popular open-source software (OSS) in the field of robotics on GitHub`: https://github.com/topics/robotics
|
|
|
|
----------------------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Table of Contents
|
|
|
|
modules/0_getting_started/0_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_inverted_pendulum/inverted_pendulum
|
|
modules/13_mission_planning/mission_planning
|
|
modules/11_utils/utils
|
|
modules/12_appendix/appendix
|
|
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|