Fixed some warnings, adding gazebo basics draft.

Author: Murilo Marinho

.devcontainer/serve_sphinx.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
 set -e
 
-# This is expected to be run at the root of the repository 
+# This is expected to be run at the root of the repository
 sphinx-autobuild docs/source build/html

docs/source/cpp/cpp_vent.rst

@@ -60,7 +60,7 @@ In things entirely written in modern C++ (loosely C++11 and above, but C++14 and
 
 Use `smart pointers <https://en.cppreference.com/w/cpp/memory>`_. In general, `std::shared_ptr <https://en.cppreference.com/w/cpp/memory/shared_ptr>`_ and, if needed, `std::unique_ptr <https://en.cppreference.com/w/cpp/memory/unique_ptr>`_.
 
-If only using smart pointers you still manage to get a segmentation fault, then hats off to you.
+If only using smart pointers, you still manage to get a segmentation fault, then hats off to you.
 
 But I can get segfaults with ``std::vector``
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -69,7 +69,7 @@ As a successor of C, the standard library in C++ kept some of its predecessor's
 
 For example, with trigonometric functions in C++, the error handling is `C-like <https://en.cppreference.com/w/cpp/numeric/math/math_errhandling>`_
 
-For instance getting the ``acos`` of 1.1, which is invalid, will fail silently in C++. We must check if the output is ``NaN``, e.g. with
+For instance, getting the ``acos`` of 1.1, which is invalid, will fail silently in C++. We must check if the output is ``NaN``, e.g., with
 
 .. code-block:: cpp
 
@@ -82,7 +82,7 @@ For instance getting the ``acos`` of 1.1, which is invalid, will fail silently i
      std::cout << std::isnan(a) ? "the output was invalid but no exception was thrown " : a << std::endl;
    }
 
-the same applies if we try to access beyond a vector's limits with the good and old ``operator[]``.
+The same applies if we try to access beyond a vector's limits with the good and old ``operator[]``.
 Instead of doing that, use the method ``.at()``, which `checks the bounds <https://en.cppreference.com/w/cpp/container/vector/at>`_.
 
 .. code-block:: cpp
@@ -111,7 +111,7 @@ As a conclusion, find the correct function/method or throw an exception yourself
 But C++ makes too many copies of objects: The sonata of "I don't know `perfect forwarding <https://en.cppreference.com/w/cpp/utility/forward>`_"
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-I see this claim all the time and it has many `skill-issue <https://knowyourmeme.com/memes/skill-issue-simply-a-difference-in-skill>`_\ -related causes, but basically, it shows up more frequently in the constructors of ``std::vector`` and ``std::shared_ptr``.
+I see this claim all the time, and it has many `skill-issue <https://knowyourmeme.com/memes/skill-issue-simply-a-difference-in-skill>`_\ -related causes, but basically, it shows up more frequently in the constructors of ``std::vector`` and ``std::shared_ptr``.
 
 Let's suppose that we have a class
 

docs/source/gazebo/gazebo_installation.rst

@@ -0,0 +1,22 @@
+.. _Gazebo installation:
+
+Gazebo Installation
+===================
+
+The following command will install :program:`Gazebo Harmonic` and all the pairing libraries for :program:`ROS2 Jazzy`.
+
+.. rli:: https://raw.githubusercontent.com/UoMMScRobotics/SFR_Gazebo/refs/heads/main/install_gazebo.sh
+   :language: bash
+   :lines: 5-15
+
+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.
+
+===========================   ================================================================================================================================================
+curl_                         Helps download files from the terminal.
+`lsb-release`_                  The lsb_release command is a simple tool to help identify the Linux distribution being used and its compliance with the Linux Standard Base
+gnupg_                        :program:`GnuPG` is an universal crypto engine which can be used directly from a command line prompt, from shell scripts, or from other programs.
+===========================   ================================================================================================================================================
+
+.. _curl: https://curl.se/
+.. _`lsb-release`: https://packages.debian.org/sid/lsb-release
+.. _gnupg: https://gnupg.org/download/

docs/source/gazebo/installation.rst

@@ -115,6 +115,13 @@ This is a tutorial that supposes that the user will follow it linearly. Some rea
    launch_configurable_nodes
    inspecting_parameters
 
+.. toctree::
+   :caption: Gazebo Basics
+   :maxdepth: 2
+   :hidden:
+
+   gazebo/installation
+
 .. toctree::
    :caption: ROS2 C++ Basics
    :maxdepth: 2

docs/source/index.rst

@@ -117,7 +117,7 @@ If everything is correct, we'll get
 
    Set parameter successful
 
-.. info::
+.. important::
 
    Some errors are easy to debug, such as when we get the name of the Node wrong
 

docs/source/inspecting_parameters.rst

@@ -3,7 +3,7 @@
 Python Basics
 =============
 
-.. info::
+.. important::
    This tutorial expects prior knowledge in Python and object-oriented programming.
    As such, this section is not meant to be a comprehensive Python tutorial. You have better resources
    made by smarter people available online, e.g. `The Python Tutorial <https://docs.python.org/3.10/tutorial/index.html>`_.

docs/source/preamble/python.rst

@@ -47,7 +47,7 @@ Then, you can run :program:`PyCharm` with
 
     pycharm_ros2
 
-.. info::
+.. important::
    We use :program:`pycharm_ros2` instead of :program:`pycharm` on purpose. This prevents our alias from misbehaving if you have another version of :program:`PyCharm` installed.
 
 2024.09 Update

docs/source/preamble/python/editing_python_source_pycharm.rst

@@ -172,7 +172,7 @@ So, enough of this example, let's get rid of everything with
 :program:`bash` redirections
 ----------------------------
 
-.. info::
+.. important::
 
    More info is available at the `Bash Reference Manual <https://www.gnu.org/software/bash/manual/html_node/Redirections.html>`_.