Skip to content

Commit b653210

Browse files
author
Murilo Marinho
committed
Cosmetic adjustments for the Gazebo part.
1 parent 40c7b76 commit b653210

File tree

5 files changed

+20
-6
lines changed

5 files changed

+20
-6
lines changed

docs/source/gazebo/about.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
.. include:: ../the_topic_is_under_heavy_construction.rst
22

3+
.. versionadded:: Jazzy
4+
5+
Added this section.
6+
37
About :program:`Gazebo`
48
=======================
59

docs/source/gazebo/installation.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
11
.. include:: ../the_topic_is_under_heavy_construction.rst
22

3+
.. versionadded:: Jazzy
4+
5+
Added this section.
6+
37
.. _Gazebo installation:
48

59
:program:`Gazebo` Installation
610
==============================
711

8-
The following command will install :program:`Gazebo Harmonic` and all the pairing libraries for :program:`ROS2 Jazzy`.
12+
The following command will install :program:`Gazebo Harmonic` and all the pairing libraries for :program:`ROS2 Jazzy`. Please do not attempt to install it following another documentation. This could lead to a different version being installed.
913

1014
.. rli:: https://raw.githubusercontent.com/UoMMScRobotics/SFR_Gazebo/refs/heads/main/install_gazebo.sh
1115
:language: bash
1216
:lines: 5-15
1317

14-
Here is the description of the packages we are installing. You can notice that the packages are being used in the commands to add the :program:`Gazebo Harmonic` packages to our :program:`apt` sources.
18+
Here is the description of the packages we are installing. You can notice that the packages are being used in the commands to add the :program:`Gazebo Harmonic` packages to our :program:`apt` sources. We're just telling :program:`apt` where to find the packages and install those.
1519

1620
=========================== =================================================================================================================================================
1721
curl_ Helps download files from the terminal.
@@ -29,7 +33,7 @@ After installation, :program:`Gazebo Harmonic` can be run with the following com
2933
gz sim
3034
3135
Which should result in something similar to the following, if the installation went well.
32-
I would recommend strongly against letting the curiosity get the best of you and clicking on the ``3d_shapes.sdf`` given that it's current freezing all my machines.
36+
I would recommend strongly against letting the curiosity get the best of you and clicking on the ``3k_shapes.sdf`` given that it's current freezing all my machines.
3337
Other scenes seem to be working in general.
3438

3539
.. image:: images/screen_quickstart.png

docs/source/gazebo/quickstart.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
.. include:: ../the_topic_is_under_heavy_construction.rst
22

3+
.. versionadded:: Jazzy
4+
5+
Added this section.
6+
37
Using :program:`Gazebo`
48
=======================
59

docs/source/index.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,11 +159,13 @@ If you enjoyed this tutorial, please
159159
inspecting_services
160160

161161
.. toctree::
162-
:caption: Gazebo Basics
162+
:caption: Gazebo
163163
:maxdepth: 2
164164
:hidden:
165165

166+
gazebo/about
166167
gazebo/installation
168+
gazebo/quickstart
167169

168170
.. toctree::
169171
:caption: ROS2 C++ Basics

docs/source/parameters_and_launch.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Parameters: creating configurable Nodes
2-
=======================================
1+
Parameters and launch files: creating configurable Nodes
2+
========================================================
33

44
The Nodes we have made in the past few sections are interesting because they take advantage of the interprocess communication provided by ROS2.
55

0 commit comments

Comments
 (0)