Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
eb33d80
Adding devcontainer settings and making some modifications to jazzy
mmmarinho Jul 26, 2025
3bd3ca3
[installation.rst] Updating from Humble to Jazzy.
mmmarinho Jul 26, 2025
31175ff
[create_packages.rst] Updated to jazzy
mmmarinho Jul 26, 2025
bf79887
[create_python_package.rst] Updated to Jazzy.
mmmarinho Jul 26, 2025
43e6ba9
[create_python_node_with_template.rst] Updated to Jazzy.
mmmarinho Jul 26, 2025
b1a1779
[running_node.rst] Updated to Jazzy.
mmmarinho Jul 26, 2025
4491f5d
[create_python_node_from_scratch.rst] Updated to Jazzy.
mmmarinho Jul 26, 2025
74478bd
Fixing warnings in multiple files
mmmarinho Jul 27, 2025
0be2e1c
[create_python_library.rst] Adjusted for Jazzy.
mmmarinho Jul 27, 2025
643c803
[using_python_library.rst] Updating to Jazzy.
mmmarinho Jul 27, 2025
2dc4fbc
messages.rst Updated to Jazzy.
mmmarinho Jul 27, 2025
b73b51a
[create_interface_package.rst] Updated to Jazzy
mmmarinho Jul 27, 2025
eecc031
Adding mermaid diagram with dark mode.
mmmarinho Jul 28, 2025
6fcd892
[publishers_and_subscribers.rst] Updated to Jazzy.
mmmarinho Jul 28, 2025
45cd34d
Removing WhatIsThePoint, adding new message to keep teachable points,…
mmmarinho Jul 28, 2025
621744f
[python_package_that_uses_the_services] Switching from AmazingQuote t…
mmmarinho Jul 28, 2025
4ea1160
[python_package_that_uses_the_services] Fixing node names and syntax.
mmmarinho Jul 28, 2025
df7d5d5
[service_servers_and_clients.rst] Updated example to use AddPoints.
mmmarinho Jul 28, 2025
1932850
[inspecting_services.rst] Update to use AddPoints.srv
mmmarinho Jul 28, 2025
436759f
[parameters] Adjusted parameter-related files to Jazzy.
mmmarinho Jul 28, 2025
01af02b
[installing_python.rst] Updating to Ubuntu 24.04 versions.
mmmarinho Jul 28, 2025
e41d256
[conf.py] Updating announcement for clarify.
mmmarinho Jul 28, 2025
f7b293f
[publishers_and_subscribers.rst] Fixing warnings
mmmarinho Jul 28, 2025
76a84a5
[publishers_and_subscribers] Fixing id reference.
mmmarinho Jul 28, 2025
64173de
[puppeteer-config.json] Fixed spelling.
mmmarinho Jul 28, 2025
e38a890
Merge branch 'main' into working
mmmarinho Jul 28, 2025
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
6 changes: 3 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
]

intersphinx_mapping = {
'python': ('https://docs.python.org/3.10/', None),
'python': ('https://docs.python.org/3.12/', None),
'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
}
intersphinx_disabled_domains = ['std']
Expand All @@ -48,8 +48,8 @@
html_theme = 'sphinx_book_theme'
# Tried with `furo` on May 23, 2025, but somehow it didn't look right. In particular the download button wasn't as clear.
html_theme_options = {
"announcement": "The documentation is being updated to Jazzy in this branch. "
"See <a href='https://ros2-tutorial.readthedocs.io/en/humble/'>Humble Docs</a> for the stable ones. "
"announcement": "This tutorial has been updated to ROS2 Jazzy. "
"See <a href='https://ros2-tutorial.readthedocs.io/en/humble/'>Humble Docs</a> for the previous version. "
"Create an <a href='https://github.com/mmmarinho/ROS2_Tutorial/issues'>issue</a> for inconsistencies.",
}
html_title = project
Expand Down
48 changes: 24 additions & 24 deletions docs/source/preamble/python/installing_python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Installing Python on Ubuntu
If you change or try to tinker with the default Python version of Ubuntu, your system will most likely **BREAK COMPLETELY**.
Do not play around with the default Python installation, because Ubuntu depends on it to work properly (or work at all).

In Ubuntu 22.04, Python is already installed!
In Ubuntu, Python is already installed!
In fact, Ubuntu would not work without it. Let's check its version by running

.. code-block:: console
Expand All @@ -18,9 +18,9 @@ which should output

.. code-block:: console

Python 3.10.6
Python 3.12.3

If the :code:`3.10` part of your version is different (e.g. :code:`3.9` or :code:`3.11`\), get this fixed because this tutorial will not work for you.
If the :code:`3.12` part of your version is different, this tutorial might not work for you. Please make sure to use the default Python in your Ubuntu.

.. warning::
Note that the command is :program:`python3` and not :program:`python`. In fact, the result of
Expand Down Expand Up @@ -50,13 +50,13 @@ which should output something similar to

.. code-block:: console

Python 3.10.6 (main, Mar 10 2023, 10:55:28) [GCC 11.3.0] on linux
Python 3.12.3 (main, Jun 18 2025, 17:59:45) [GCC 13.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>>

in particular, if the :code:`GCC 11` is different, e.g. :code:`GCC 9` or :code:`GCC 12`\, then get this fixed because this tutorial will not work for you.
in particular, if the :code:`GCC 13` is different, then this tutorial might not work for you.

As you already know, to exit the `interactive shell <https://docs.python.org/3.10/tutorial/interpreter.html>`_ you can use :kbd:`CTRL+D` or type :code:`quit()` and press :kbd:`ENTER`.
As you already know, to exit the `interactive shell <https://docs.python.org/3.12/tutorial/interpreter.html>`_ you can use :kbd:`CTRL+D` or type :code:`quit()` and press :kbd:`ENTER`.

Some Python packages must be installed through :program:`apt`
-------------------------------------------------------------
Expand All @@ -83,7 +83,7 @@ When you want to isolate your environment, use :program:`venv`
Until that is handled, we are not going to use :program:`venv` for the ROS2 tutorials.
However, we will use :program:`venv` to protect our ROS2 environment from these Python preamble tutorials.

Using :program:`venv` (`More info <https://docs.python.org/3.10/library/venv.html>`_) is quite straightforward.
Using :program:`venv` (`More info <https://docs.python.org/3.12/library/venv.html>`_) is quite straightforward.

Create a :file:`venv`
^^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -151,20 +151,20 @@ then, we install

.. code-block:: console

python3 -m pip install dqrobotics
python3 -m pip install dqrobotics --break-system-packages

which will result in something similar to (might change depending on future versions)

.. code-block:: console

Collecting dqrobotics
Downloading dqrobotics-23.4.0a15-cp310-cp310-manylinux1_x86_64.whl (551 kB)
---------------------------------------- 551.4/551.4 KB 6.3 MB/s eta 0:00:00
Collecting numpy
Downloading numpy-1.25.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (17.6 MB)
---------------------------------------- 17.6/17.6 MB 7.4 MB/s eta 0:00:00
Installing collected packages: numpy, dqrobotics
Successfully installed dqrobotics-23.4.0a15 numpy-1.25.0
Collecting dqrobotics
Downloading dqrobotics-25.4.0a17-cp312-cp312-manylinux2014_aarch64.whl.metadata (2.9 kB)
Requirement already satisfied: numpy in /usr/lib/python3/dist-packages (from dqrobotics) (1.26.4)
Downloading dqrobotics-25.4.0a17-cp312-cp312-manylinux2014_aarch64.whl (512 kB)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 512.5/512.5 kB 14.0 MB/s eta 0:00:00
[...]
Installing collected packages: dqrobotics
Successfully installed dqrobotics-25.4.0a17

Removing libraries (installed with :program:`pip`)
--------------------------------------------------
Expand All @@ -173,18 +173,18 @@ We can remove the library we just installed with

.. code-block:: console

python3 -m pip uninstall dqrobotics
python3 -m pip uninstall dqrobotics --break-system-packages

resulting in

.. code-block:: console

Found existing installation: dqrobotics 23.4.0a15
Uninstalling dqrobotics-23.4.0a15:
Would remove:
/home/murilo/ros2tutorial_venv/lib/python3.10/site-packages/dqrobotics-23.4.0a15.dist-info/*
/home/murilo/ros2tutorial_venv/lib/python3.10/site-packages/dqrobotics/*
Proceed (Y/n)?
Found existing installation: dqrobotics 25.4.0a7
Uninstalling dqrobotics-25.4.0a7:
Would remove:
/usr/local/lib/python3.12/dist-packages/dqrobotics-25.4.0a7.dist-info/*
/usr/local/lib/python3.12/dist-packages/dqrobotics/*
Proceed (Y/n)?

.. hint::

Expand All @@ -195,7 +195,7 @@ Then, press :kbd:`ENTER`, which results in

.. code-block:: console

Successfully uninstalled dqrobotics-23.4.0a15
Successfully uninstalled dqrobotics-25.4.0a7

When using :program:`pip`, do **NOT** use :code:`sudo`
------------------------------------------------------
Expand Down
18 changes: 9 additions & 9 deletions docs/source/publishers_and_subscribers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -136,14 +136,14 @@ The publisher must be created with the :code:`Node.create_publisher(...)` method

.. _publisher and subscriber parameter table:

+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|:code:`msg_type` | A class, namely the message that will be used in the topic. In this case, :code:`AmazingQuote`. |
+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|:code:`topic` | The topic through which the communication will occur. Can be arbitrarily chosen, but to make sense :code:`/amazing_quote`. |
+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|:code:`qos_profile` | The simplest interpretation for this parameter is the maximum number of messages that will be stored in a buffer if your node (including :code:`spin(...)`) takes too long to process them. |
| | (See more on `docs for QoSProfile <https://docs.ros.org/en/humble/Concepts/About-Quality-of-Service-Settings.html>`_.) |
+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|:code:`msg_type` | A class, namely the message that will be used in the topic. In this case, :code:`AmazingQuote`. |
+--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|:code:`topic` | The topic through which the communication will occur. Can be arbitrarily chosen, but to make sense :code:`/amazing_quote`. |
+--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|:code:`qos_profile` | The simplest interpretation for this parameter is the maximum number of messages that will be stored in a buffer if your node (including :code:`spin(...)`) takes too long to process them. |
| | (See more on `docs for QoSProfile <https://docs.ros.org/en/humble/Concepts/About-Quality-of-Service-Settings.html>`_.) |
+--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. warning::

Expand Down Expand Up @@ -292,6 +292,6 @@ which outputs

.. warning::

Unless instructed otherwise, the publisher does **NOT** wait for a subscriber to connect before it starts publishing the messages. As shown in the case above, the first message we received started with `id=3`. If we delayed longer to start the publisher, we would have received later messages only.
Unless instructed otherwise, the publisher does **NOT** wait for a subscriber to connect before it starts publishing the messages. As shown in the case above, the first message we received started with `id>0`. If we delayed longer to start the publisher, we would have received later messages only.

Let's close each node with :kbd:`CTRL+C` on each terminal before we proceed to the next tutorial.
3 changes: 3 additions & 0 deletions docs/source/puppeteer-config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"args": ["--no-sandbox"]
}