From 5fbddfe7c70aacd9b9ed8d8578fb75fe381e1f74 Mon Sep 17 00:00:00 2001 From: eProsima Date: Wed, 16 Oct 2024 23:00:55 +0200 Subject: [PATCH 1/2] Refs #21907: Include link to Python installation Getting started Signed-off-by: eProsima --- .../simple_python_app/includes/prerequisites.rst | 6 ++++++ .../getting_started/simple_python_app/simple_python_app.rst | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) create mode 100644 docs/fastdds/getting_started/simple_python_app/includes/prerequisites.rst diff --git a/docs/fastdds/getting_started/simple_python_app/includes/prerequisites.rst b/docs/fastdds/getting_started/simple_python_app/includes/prerequisites.rst new file mode 100644 index 000000000..2dc03eadd --- /dev/null +++ b/docs/fastdds/getting_started/simple_python_app/includes/prerequisites.rst @@ -0,0 +1,6 @@ +Prerequisites +^^^^^^^^^^^^^ + +First of all, you need to follow the steps outlined in the :ref:`Installation Manual ` +section for the installation of *eProsima Fast DDS Python* and all its dependencies. +Moreover, all the commands provided in this tutorial are outlined for a Linux environment. diff --git a/docs/fastdds/getting_started/simple_python_app/simple_python_app.rst b/docs/fastdds/getting_started/simple_python_app/simple_python_app.rst index 9c12f0fbb..e9ee3254b 100644 --- a/docs/fastdds/getting_started/simple_python_app/simple_python_app.rst +++ b/docs/fastdds/getting_started/simple_python_app/simple_python_app.rst @@ -16,7 +16,7 @@ using Python API step by step. .. include:: ../simple_app/includes/background.rst -.. include:: ../simple_app/includes/prerequisites.rst +.. include:: includes/prerequisites.rst .. include:: includes/workspace.rst From 7059d420f2c5f54b04a94a31f8a5430934d7be51 Mon Sep 17 00:00:00 2001 From: eProsima Date: Thu, 17 Oct 2024 09:24:55 +0200 Subject: [PATCH 2/2] Refs #21907: Apply rev suggestions Signed-off-by: eProsima --- .../simple_python_app/includes/prerequisites.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/fastdds/getting_started/simple_python_app/includes/prerequisites.rst b/docs/fastdds/getting_started/simple_python_app/includes/prerequisites.rst index 2dc03eadd..e2e638c8e 100644 --- a/docs/fastdds/getting_started/simple_python_app/includes/prerequisites.rst +++ b/docs/fastdds/getting_started/simple_python_app/includes/prerequisites.rst @@ -1,6 +1,9 @@ Prerequisites ^^^^^^^^^^^^^ -First of all, you need to follow the steps outlined in the :ref:`Installation Manual ` +First of all, please follow the steps outlined in the :ref:`Installation Manual ` section for the installation of *eProsima Fast DDS Python* and all its dependencies. -Moreover, all the commands provided in this tutorial are outlined for a Linux environment. + +.. note:: + + All the commands provided in this tutorial are outlined for a Linux environment.