Skip to content

Commit 44bad78

Browse files
authored
update getting started (AtsushiSakai#1132)
1 parent fc35627 commit 44bad78

7 files changed

+27
-16
lines changed

docs/how_to_read_textbook_main.rst

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/index_main.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ this graph shows GitHub star history of this project:
3333
:maxdepth: 2
3434
:caption: Table of Contents
3535

36-
getting_started
36+
modules/0_getting_started/0_getting_started
3737
modules/1_introduction/introduction
3838
modules/2_localization/localization
3939
modules/3_mapping/mapping
@@ -46,7 +46,6 @@ this graph shows GitHub star history of this project:
4646
modules/10_control/control
4747
modules/11_utils/utils
4848
modules/12_appendix/appendix
49-
how_to_contribute
5049

5150

5251
Indices and tables

docs/getting_started_main.rst renamed to docs/modules/0_getting_started/0_getting_started_main.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Getting Started
77
:maxdepth: 2
88
:caption: Contents
99

10-
what_is_python_robotics
11-
how_to_use
12-
how_to_read_textbook
10+
1_what_is_python_robotics
11+
2_how_to_use
12+
3_how_to_contribute
13+
4_how_to_read_textbook

docs/what_is_python_robotics_main.rst renamed to docs/modules/0_getting_started/1_what_is_python_robotics_main.rst

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ These codes are developed under `MIT license`_ and on `GitHub`_.
88

99
This project has three main philosophies below:
1010

11-
1. Easy to understand each algorithm's basic idea.
11+
Philosophy 1. Easy to understand each algorithm's basic idea.
1212
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1313

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

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

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

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

4352

44-
2. Widely used and practical algorithms are selected.
53+
Philosophy 2. Widely used and practical algorithms are selected.
4554
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4655

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

56-
3. Minimum dependency.
65+
Philosophy 3. Minimum dependency.
5766
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5867

5968
Each sample code is written in Python3 and only depends on some standard
@@ -84,7 +93,7 @@ For development:
8493
- `pytest`_ (for unit tests)
8594
- `pytest-xdist`_ (for parallel unit tests)
8695
- `mypy`_ (for type check)
87-
- `sphinx`_ (for document generation)
96+
- `Sphinx`_ (for document generation)
8897
- `ruff`_ (for code style check)
8998

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.. _`How to read this textbook`:
2+
3+
How to read this textbook
4+
--------------------------
5+
6+
TBD

0 commit comments

Comments
 (0)