Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions docs/how_to_read_textbook_main.rst

This file was deleted.

3 changes: 1 addition & 2 deletions docs/index_main.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ this graph shows GitHub star history of this project:
:maxdepth: 2
:caption: Table of Contents

getting_started
modules/0_getting_started/0_getting_started
modules/1_introduction/introduction
modules/2_localization/localization
modules/3_mapping/mapping
Expand All @@ -46,7 +46,6 @@ this graph shows GitHub star history of this project:
modules/10_control/control
modules/11_utils/utils
modules/12_appendix/appendix
how_to_contribute


Indices and tables
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Getting Started
:maxdepth: 2
:caption: Contents

what_is_python_robotics
how_to_use
how_to_read_textbook
1_what_is_python_robotics
2_how_to_use
3_how_to_contribute
4_how_to_read_textbook
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ These codes are developed under `MIT license`_ and on `GitHub`_.

This project has three main philosophies below:

1. Easy to understand each algorithm's basic idea.
Philosophy 1. Easy to understand each algorithm's basic idea.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The goal is for beginners in robotics to understand the basic ideas behind each algorithm.
Expand All @@ -31,17 +31,26 @@ path planning in a highway scenario for autonomous vehicle.
.. image:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathPlanning/FrenetOptimalTrajectory/high_speed_and_velocity_keeping_frenet_path.gif

This animation is a gif file and is created using the `Matplotlib`_ library.
All animaion gif files are stored in the `PythonRoboticsGifs`_ repository and
all animation movies are uploaded to this `YouTube channel`_.
All animation gif files are stored in the `PythonRoboticsGifs`_ repository and
all animation movies are also uploaded to this `YouTube channel`_.

PythonRobotics also provides a textbook that explains the basic ideas of each algorithm.
The PythonRobotics textbook allows you to learn fundamental algorithms used in
robotics with minimal mathematical formulas and textual explanations,
based on PythonRobotics’ sample codes and animations.
The contents of this document, like the code, are managed in the PythonRobotics
`GitHub`_ repository and converted into HTML-based online documents using `Sphinx`_,
which is a Python-based documentation builder.
Please refer to this section ":ref:`How to read this textbook`" for information on
how to read this document for learning.


.. _`Python`: https://www.python.org/
.. _`PythonRoboticsGifs`: https://github.com/AtsushiSakai/PythonRoboticsGifs
.. _`YouTube channel`: https://youtube.com/playlist?list=PL12URV8HFpCozuz0SDxke6b2ae5UZvIwa&si=AH2fNPPYufPtK20S


2. Widely used and practical algorithms are selected.
Philosophy 2. Widely used and practical algorithms are selected.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The second philosophy is that implemented algorithms have to be practical
Expand All @@ -53,7 +62,7 @@ dynamic programming based approaches and sampling based approaches for path plan
and optimal control based approach for path tracking.
These algorithms are implemented in this project.

3. Minimum dependency.
Philosophy 3. Minimum dependency.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Each sample code is written in Python3 and only depends on some standard
Expand Down Expand Up @@ -84,7 +93,7 @@ For development:
- `pytest`_ (for unit tests)
- `pytest-xdist`_ (for parallel unit tests)
- `mypy`_ (for type check)
- `sphinx`_ (for document generation)
- `Sphinx`_ (for document generation)
- `ruff`_ (for code style check)

.. _`Python 3.12.x`: https://www.python.org/
Expand All @@ -95,6 +104,6 @@ For development:
.. _`pytest`: https://docs.pytest.org/en/latest/
.. _`pytest-xdist`: https://github.com/pytest-dev/pytest-xdist
.. _`mypy`: https://mypy-lang.org/
.. _`sphinx`: https://www.sphinx-doc.org/en/master/index.html
.. _`Sphinx`: https://www.sphinx-doc.org/en/master/index.html
.. _`ruff`: https://github.com/astral-sh/ruff

File renamed without changes.
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`How to read this textbook`:

How to read this textbook
--------------------------

TBD