Skip to content

create sections for Gazebo and Gazebo Classic setup guide. #864

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SteveMacenski merged 2 commits into from
Feb 9, 2026
Merged

create sections for Gazebo and Gazebo Classic setup guide. #864

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
19cb52f
create sections for Gazebo and Gazebo Classic setup guide.
fujitatomoya Feb 8, 2026
9e7f9db
keep 2 column structure for visual aid.
fujitatomoya Feb 9, 2026
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
23 changes: 23 additions & 0 deletions setup_guides/gazebo.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
.. _setup_guides_gazebo:

Setup Guide for Gazebo
#######################

This guide covers setting up Navigation2 with the modern Gazebo simulator (Gazebo Harmonic or newer), used with ROS 2 Jazzy or newer.

Follow these tutorials in order to set up your robot for Nav2:

.. toctree::
:maxdepth: 1

transformation/setup_transforms.rst
urdf/setup_urdf.rst
sdf/setup_sdf.rst
odom/setup_odom_gz.rst
odom/setup_robot_localization.rst
sensors/setup_sensors_gz.rst
sensors/mapping_localization.rst
footprint/setup_footprint.rst
algorithm/select_algorithm.rst

.. 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.
22 changes: 22 additions & 0 deletions setup_guides/gazebo_classic.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
.. _setup_guides_gazebo_classic:

Setup Guide for Gazebo Classic
###############################

This guide covers setting up Navigation2 with Gazebo Classic simulator, used with ROS 2 Humble and previous ROS distributions.

Follow these tutorials in order to set up your robot for Nav2:

.. toctree::
:maxdepth: 1

transformation/setup_transforms.rst
urdf/setup_urdf.rst
odom/setup_odom_gz_classic.rst
odom/setup_robot_localization.rst
sensors/setup_sensors_gz_classic.rst
sensors/mapping_localization.rst
footprint/setup_footprint.rst
algorithm/select_algorithm.rst

.. 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.
49 changes: 12 additions & 37 deletions setup_guides/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,54 +23,29 @@ To guide you through the first-time setup of your robot, we will be tackling the

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.


Table of Contents
=================
Choose the appropriate guide based on your ROS 2 distribution:

.. raw:: html

<div style="display: flex; gap: 20px;">

<div style="flex: 1; padding: 10px; border-right: 1px solid #ccc;">

<h3 style="text-align: center;">Gazebo</h3>
<div style="display: grid; grid-template-columns: 1fr 1fr; gap: 20px; margin: 20px 0;">
<div>

.. toctree::
:maxdepth: 1

transformation/setup_transforms.rst
urdf/setup_urdf.rst
sdf/setup_sdf.rst
odom/setup_odom_gz.rst
odom/setup_robot_localization.rst
sensors/setup_sensors_gz.rst
sensors/mapping_localization.rst
footprint/setup_footprint.rst
algorithm/select_algorithm.rst
:maxdepth: 2

.. raw:: html
gazebo.rst

</div>

<div style="flex: 1; padding: 10px;">
.. raw:: html

<h3 style="text-align: center;">Gazebo Classic</h3>
</div>
<div>

.. toctree::
:maxdepth: 1
:maxdepth: 2

transformation/setup_transforms.rst
urdf/setup_urdf.rst
odom/setup_odom_gz_classic.rst
odom/setup_robot_localization.rst
sensors/setup_sensors_gz_classic.rst
sensors/mapping_localization.rst
footprint/setup_footprint.rst
algorithm/select_algorithm.rst
gazebo_classic.rst

.. raw:: html

</div>
</div>

.. 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.
</div>
</div>
Loading