Skip to content

Commit 1441e26

Browse files
fujitatomoyamach0312
authored andcommitted
create sections for Gazebo and Gazebo Classic setup guide. (ros-navigation#864)
* create sections for Gazebo and Gazebo Classic setup guide. Signed-off-by: Tomoya.Fujita <tomoya.fujita825@gmail.com> * keep 2 column structure for visual aid. Signed-off-by: Tomoya.Fujita <Tomoya.Fujita@sony.com> --------- Signed-off-by: Tomoya.Fujita <tomoya.fujita825@gmail.com> Signed-off-by: Tomoya.Fujita <Tomoya.Fujita@sony.com> Signed-off-by: Jaerak Son <sjr9017@naver.com>
1 parent 14059e0 commit 1441e26

3 files changed

Lines changed: 57 additions & 37 deletions

File tree

setup_guides/gazebo.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. _setup_guides_gazebo:
2+
3+
Setup Guide for Gazebo
4+
#######################
5+
6+
This guide covers setting up Navigation2 with the modern Gazebo simulator (Gazebo Harmonic or newer), used with ROS 2 Jazzy or newer.
7+
8+
Follow these tutorials in order to set up your robot for Nav2:
9+
10+
.. toctree::
11+
:maxdepth: 1
12+
13+
transformation/setup_transforms.rst
14+
urdf/setup_urdf.rst
15+
sdf/setup_sdf.rst
16+
odom/setup_odom_gz.rst
17+
odom/setup_robot_localization.rst
18+
sensors/setup_sensors_gz.rst
19+
sensors/mapping_localization.rst
20+
footprint/setup_footprint.rst
21+
algorithm/select_algorithm.rst
22+
23+
.. note:: These tutorials are not meant to be full tuning and configuration guides since they only aim to help you get your robot up and running with a basic configuration. For more detailed discussions and guides on how to customize and tune Nav2 for your robot, head on to the :ref:`configuration` section.

setup_guides/gazebo_classic.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
.. _setup_guides_gazebo_classic:
2+
3+
Setup Guide for Gazebo Classic
4+
###############################
5+
6+
This guide covers setting up Navigation2 with Gazebo Classic simulator, used with ROS 2 Humble and previous ROS distributions.
7+
8+
Follow these tutorials in order to set up your robot for Nav2:
9+
10+
.. toctree::
11+
:maxdepth: 1
12+
13+
transformation/setup_transforms.rst
14+
urdf/setup_urdf.rst
15+
odom/setup_odom_gz_classic.rst
16+
odom/setup_robot_localization.rst
17+
sensors/setup_sensors_gz_classic.rst
18+
sensors/mapping_localization.rst
19+
footprint/setup_footprint.rst
20+
algorithm/select_algorithm.rst
21+
22+
.. note:: These tutorials are not meant to be full tuning and configuration guides since they only aim to help you get your robot up and running with a basic configuration. For more detailed discussions and guides on how to customize and tune Nav2 for your robot, head on to the :ref:`configuration` section.

setup_guides/index.rst

Lines changed: 12 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -23,54 +23,29 @@ To guide you through the first-time setup of your robot, we will be tackling the
2323

2424
There are tutorials below for the Gazebo Classic simulator and the Gazebo simulator. Gazebo Classic is used with ROS 2 Humble and previous ROS distributions, while Gazebo (Gazebo Harmonic or newer) is used with ROS 2 Jazzy or newer.
2525

26-
27-
Table of Contents
28-
=================
26+
Choose the appropriate guide based on your ROS 2 distribution:
2927

3028
.. raw:: html
3129

32-
<div style="display: flex; gap: 20px;">
33-
34-
<div style="flex: 1; padding: 10px; border-right: 1px solid #ccc;">
35-
36-
<h3 style="text-align: center;">Gazebo</h3>
30+
<div style="display: grid; grid-template-columns: 1fr 1fr; gap: 20px; margin: 20px 0;">
31+
<div>
3732

3833
.. toctree::
39-
:maxdepth: 1
40-
41-
transformation/setup_transforms.rst
42-
urdf/setup_urdf.rst
43-
sdf/setup_sdf.rst
44-
odom/setup_odom_gz.rst
45-
odom/setup_robot_localization.rst
46-
sensors/setup_sensors_gz.rst
47-
sensors/mapping_localization.rst
48-
footprint/setup_footprint.rst
49-
algorithm/select_algorithm.rst
34+
:maxdepth: 2
5035

51-
.. raw:: html
36+
gazebo.rst
5237

53-
</div>
54-
55-
<div style="flex: 1; padding: 10px;">
38+
.. raw:: html
5639

57-
<h3 style="text-align: center;">Gazebo Classic</h3>
40+
</div>
41+
<div>
5842

5943
.. toctree::
60-
:maxdepth: 1
44+
:maxdepth: 2
6145

62-
transformation/setup_transforms.rst
63-
urdf/setup_urdf.rst
64-
odom/setup_odom_gz_classic.rst
65-
odom/setup_robot_localization.rst
66-
sensors/setup_sensors_gz_classic.rst
67-
sensors/mapping_localization.rst
68-
footprint/setup_footprint.rst
69-
algorithm/select_algorithm.rst
46+
gazebo_classic.rst
7047

7148
.. raw:: html
7249

73-
</div>
74-
</div>
75-
76-
.. note:: These tutorials are not meant to be full tuning and configuration guides since they only aim to help you get your robot up and running with a basic configuration. For more detailed discussions and guides on how to customize and tune Nav2 for your robot, head on to the :ref:`configuration` section.
50+
</div>
51+
</div>

0 commit comments

Comments
 (0)