Skip to content

Commit

Permalink
Update Table of Contents - from code review
Browse files Browse the repository at this point in the history
Signed-off-by: Aarav Gupta <[email protected]>
  • Loading branch information
Amronos committed Jan 8, 2025
1 parent 937c420 commit 2f92964
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 3 deletions.
37 changes: 35 additions & 2 deletions setup_guides/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,20 +23,53 @@ 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:**
Table of Contents
=================

.. 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>

.. toctree::
:maxdepth: 1
:hidden:

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

.. raw:: html

</div>

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

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

.. toctree::
:maxdepth: 1
:hidden:

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
footprint/setup_footprint.rst
algorithm/select_algorithm.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.
2 changes: 1 addition & 1 deletion setup_guides/sdf/setup_sdf.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _sdf_handson:

Setting Up The SDF - Gazebo
#######################
###########################

0 comments on commit 2f92964

Please sign in to comment.