From b41c3c630e6f7a65888ac9ecd5544576856ec2ad Mon Sep 17 00:00:00 2001 From: Emilio Cuesta Date: Thu, 17 Jul 2025 10:30:32 +0200 Subject: [PATCH 1/6] Removed duplicated cmake command and added reminder of updating LD_LIBRARY_PATH in the getting started Python example Signed-off-by: Emilio Cuesta --- .../simple_python_app/includes/dataType.rst | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/docs/fastdds/getting_started/simple_python_app/includes/dataType.rst b/docs/fastdds/getting_started/simple_python_app/includes/dataType.rst index 3e2c93457..881faa555 100644 --- a/docs/fastdds/getting_started/simple_python_app/includes/dataType.rst +++ b/docs/fastdds/getting_started/simple_python_app/includes/dataType.rst @@ -61,18 +61,15 @@ After that, the python bindings can be generated by running the following comman cmake . make -This must have generated the python binding: +This must have generated the python bindings HelloWorld.py along with corresponding the C++ libraries, _HelloWorldWrapper.so and libHelloWorld.so -* HelloWorld.py: Python module to be imported by your Python example. +.. note:: -CMakeLists.txt -"""""""""""""" -At this point the project is ready for building, compiling and generating Python bindings for this data type. -From the workspace, run the following commands. + If the user wants to use the bindings from any other directory, it is recommended that the current path is added to LD_LIBRARY_PATH: -.. code-block:: bash + .. code-block:: bash + + export LD_LIBRARY_PATH=$(pwd):$LD_LIBRARY_PATH - cmake . - make .. _SWIG: http://www.swig.org/ From 890462a01e76569fe7d161f7987379294aedb1f5 Mon Sep 17 00:00:00 2001 From: Emilio Cuesta Date: Thu, 17 Jul 2025 10:31:48 +0200 Subject: [PATCH 2/6] Updating DDS Domain image to make (writer_or_reader)-topic relation 1 to 1 Signed-off-by: Emilio Cuesta --- .../fast_dds/getting_started/dds_domain.svg | 776 +----------------- 1 file changed, 2 insertions(+), 774 deletions(-) diff --git a/docs/01-figures/fast_dds/getting_started/dds_domain.svg b/docs/01-figures/fast_dds/getting_started/dds_domain.svg index 29b557789..7ae1689ae 100644 --- a/docs/01-figures/fast_dds/getting_started/dds_domain.svg +++ b/docs/01-figures/fast_dds/getting_started/dds_domain.svg @@ -1,776 +1,4 @@ + - - - - - - - - -
-
-
- DomainParticipant -
-
-
- - DomainParticipant - - - - - - -
-
-
- DomainParticipant -
-
-
- - DomainParticipant - - - - - - -
-
-
- DomainParticipant -
-
-
- - DomainParticipant - - - - - - -
-
-
-
- Topic 1 -
-
-
-
- - Topic 1 - - - - - - -
-
-
-
- - Topic 4 - -
-
-
-
- - Topic 4 - - - - - - -
-
-
-
- Topic 3 -
-
-
-
-
- - Topic 3 - - - - - - -
-
-
-
- Topic 2 -
-
-
-
- - Topic 2 - - - - - - - - - - - - - - - - -
-
-
-
- DDS Domain -
-
-
-
- - DDS Domain - - - - - - - - - - - - - -
-
-
-
QoS
-
-
-
- - QoS - - - - - - -
-
-
- Subscriber -
-
-
- - Subscriber - - - - - - -
-
-
- DataReader -
-
-
- - DataRead... - - - - - - -
-
-
- QoS -
-
-
- - QoS - - - - - - -
-
-
- QoS -
-
-
- - QoS - - - - - - -
-
-
- QoS -
-
-
- - QoS - - - - - - -
-
-
- DataReader -
-
-
- - DataRead... - - - - - - -
-
-
- QoS -
-
-
- - QoS - - - - - - - - -
-
-
- QoS -
-
-
- - QoS - - - - - - -
-
-
- QoS -
-
-
- - QoS - - - - - - -
-
-
- QoS -
-
-
- - QoS - - - - - - -
-
-
- QoS -
-
-
- - QoS - - - - - - -
-
-
- Publisher -
-
-
- - Publisher - - - - - - -
-
-
- QoS -
-
-
- - QoS - - - - - - -
-
-
- DataWriter -
-
-
- - DataWriter - - - - - - -
-
-
- QoS -
-
-
- - QoS - - - - - - -
-
-
- DataWriter -
-
-
- - DataWriter - - - - - - -
-
-
- QoS -
-
-
- - QoS - - - - - - -
-
-
- ... -
-
-
- - ... - - - - - - - -
-
-
- Publisher -
-
-
- - Publisher - - - - - - -
-
-
- DataWriter -
-
-
- - DataWriter - - - - - - -
-
-
- QoS -
-
-
- - QoS - - - - - - -
-
-
- QoS -
-
-
- - QoS - - - - - - - - - - - -
-
-
- Publisher -
-
-
- - Publisher - - - - - - -
-
-
- DataWriter -
-
-
- - DataWriter - - - - - - -
-
-
- QoS -
-
-
- - QoS - - - - - - -
-
-
- QoS -
-
-
- - QoS - - - - - - -
-
-
- DataReader -
-
-
- - DataRead... - - - - - - -
-
-
- QoS -
-
-
- - QoS - - - - - - -
-
-
- Subscriber -
-
-
- - Subscriber - - - - - - -
-
-
- QoS -
-
-
- - QoS - - - - - - -
-
-
- DataReader -
-
-
- - DataRead... - - - - - - -
-
-
- QoS -
-
-
- - QoS - - - - - - -
-
-
- Subscriber -
-
-
- - Subscriber - - - - - - -
-
-
- QoS -
-
-
- - QoS - - - - - - - -
-
-
-
QoS
-
-
-
- - QoS - - - - - - - -
-
-
-
QoS
-
-
-
- - QoS - - - - - - - Viewer does not support full SVG 1.1 - - - +
DomainParticipant
DomainParticipant
DomainParticipant
Topic 1
Topic 3
Topic 2
DDS Domain
QoS
Subscriber
DataReader
QoS
QoS
QoS
DataReader
QoS
QoS
QoS
QoS
Publisher
QoS
DataWriter
QoS
DataWriter
QoS
...
Publisher
DataWriter
QoS
QoS
Publisher
DataWriter
QoS
QoS
DataReader
QoS
Subscriber
QoS
DataReader
QoS
Subscriber
QoS
QoS
QoS
 \ No newline at end of file From c443622dab645822ceeeaa54bce95f21cc9aacde Mon Sep 17 00:00:00 2001 From: Emilio Cuesta Date: Thu, 17 Jul 2025 11:22:51 +0200 Subject: [PATCH 3/6] Image from previous commit was too small Signed-off-by: Emilio Cuesta --- docs/01-figures/fast_dds/getting_started/dds_domain.svg | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/01-figures/fast_dds/getting_started/dds_domain.svg b/docs/01-figures/fast_dds/getting_started/dds_domain.svg index 7ae1689ae..7cecd28fb 100644 --- a/docs/01-figures/fast_dds/getting_started/dds_domain.svg +++ b/docs/01-figures/fast_dds/getting_started/dds_domain.svg @@ -1,4 +1,4 @@ -
DomainParticipant
DomainParticipant
DomainParticipant
Topic 1
Topic 3
Topic 2
DDS Domain
QoS
Subscriber
DataReader
QoS
QoS
QoS
DataReader
QoS
QoS
QoS
QoS
Publisher
QoS
DataWriter
QoS
DataWriter
QoS
...
Publisher
DataWriter
QoS
QoS
Publisher
DataWriter
QoS
QoS
DataReader
QoS
Subscriber
QoS
DataReader
QoS
Subscriber
QoS
QoS
QoS
 \ No newline at end of file +
DomainParticipant
DomainParticipant
DomainParticipant
Topic 1
Topic 3
Topic 2
DDS Domain
QoS
Subscriber
DataReader
QoS
QoS
QoS
DataReader
QoS
QoS
QoS
QoS
Publisher
QoS
DataWriter
QoS
DataWriter
QoS
...
Publisher
DataWriter
QoS
QoS
Publisher
DataWriter
QoS
QoS
DataReader
QoS
Subscriber
QoS
DataReader
QoS
Subscriber
QoS
QoS
QoS
 \ No newline at end of file From e7dd48d344361d942184713117a9bdd86ae2a1cf Mon Sep 17 00:00:00 2001 From: Emilio Cuesta Fernandez Date: Thu, 17 Jul 2025 12:54:56 +0200 Subject: [PATCH 4/6] Update docs/fastdds/getting_started/simple_python_app/includes/dataType.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Javier Gil Avilés Signed-off-by: Emilio Cuesta Fernandez --- .../getting_started/simple_python_app/includes/dataType.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/fastdds/getting_started/simple_python_app/includes/dataType.rst b/docs/fastdds/getting_started/simple_python_app/includes/dataType.rst index 881faa555..00a871f0c 100644 --- a/docs/fastdds/getting_started/simple_python_app/includes/dataType.rst +++ b/docs/fastdds/getting_started/simple_python_app/includes/dataType.rst @@ -61,7 +61,7 @@ After that, the python bindings can be generated by running the following comman cmake . make -This must have generated the python bindings HelloWorld.py along with corresponding the C++ libraries, _HelloWorldWrapper.so and libHelloWorld.so +This must have generated the python bindings HelloWorld.py along with the corresponding the C++ libraries, _HelloWorldWrapper.so and libHelloWorld.so .. note:: From 0f0057070678db8df3ec319a7615e33c7c3cb080 Mon Sep 17 00:00:00 2001 From: Emilio Cuesta Date: Thu, 17 Jul 2025 14:23:11 +0200 Subject: [PATCH 5/6] Splitting longer lines as requested by CI Signed-off-by: Emilio Cuesta --- .../getting_started/simple_python_app/includes/dataType.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/fastdds/getting_started/simple_python_app/includes/dataType.rst b/docs/fastdds/getting_started/simple_python_app/includes/dataType.rst index 00a871f0c..244c7081a 100644 --- a/docs/fastdds/getting_started/simple_python_app/includes/dataType.rst +++ b/docs/fastdds/getting_started/simple_python_app/includes/dataType.rst @@ -61,11 +61,13 @@ After that, the python bindings can be generated by running the following comman cmake . make -This must have generated the python bindings HelloWorld.py along with the corresponding the C++ libraries, _HelloWorldWrapper.so and libHelloWorld.so +This must have generated the python bindings HelloWorld.py along with the corresponding the C++ libraries, +_HelloWorldWrapper.so and libHelloWorld.so .. note:: - If the user wants to use the bindings from any other directory, it is recommended that the current path is added to LD_LIBRARY_PATH: + If the user wants to use the bindings from any other directory, it is recommended to add the current path + to LD_LIBRARY_PATH .. code-block:: bash From 5b0215a4d9b8bdb77db524dd7eea9ac983ed6755 Mon Sep 17 00:00:00 2001 From: Emilio Cuesta Date: Thu, 17 Jul 2025 17:20:03 +0200 Subject: [PATCH 6/6] minor fix to pass spell tests Signed-off-by: Emilio Cuesta --- .../getting_started/simple_python_app/includes/dataType.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/fastdds/getting_started/simple_python_app/includes/dataType.rst b/docs/fastdds/getting_started/simple_python_app/includes/dataType.rst index 244c7081a..6d01609e0 100644 --- a/docs/fastdds/getting_started/simple_python_app/includes/dataType.rst +++ b/docs/fastdds/getting_started/simple_python_app/includes/dataType.rst @@ -61,13 +61,13 @@ After that, the python bindings can be generated by running the following comman cmake . make -This must have generated the python bindings HelloWorld.py along with the corresponding the C++ libraries, -_HelloWorldWrapper.so and libHelloWorld.so +This must have generated the python bindings ``HelloWorld.py`` along with the corresponding the C++ libraries, +``_HelloWorldWrapper.so`` and ``libHelloWorld.so`` .. note:: If the user wants to use the bindings from any other directory, it is recommended to add the current path - to LD_LIBRARY_PATH + to ``LD_LIBRARY_PATH`` .. code-block:: bash