From 4cc949eabd85065bc80db37c48d892a4e01be7fe Mon Sep 17 00:00:00 2001 From: JesusPoderoso Date: Mon, 8 Jul 2024 16:47:28 +0200 Subject: [PATCH] Refs #21319: Add python optional step in binary installation sections Signed-off-by: JesusPoderoso --- docs/installation/binaries/binaries_linux.rst | 20 +++++++++++++++++-- .../binaries/binaries_windows.rst | 19 ++++++++++++++++++ 2 files changed, 37 insertions(+), 2 deletions(-) diff --git a/docs/installation/binaries/binaries_linux.rst b/docs/installation/binaries/binaries_linux.rst index 3f20662f5..e7613f6d2 100644 --- a/docs/installation/binaries/binaries_linux.rst +++ b/docs/installation/binaries/binaries_linux.rst @@ -32,8 +32,6 @@ the :code:`install.sh` script with administrative privileges: By default, *eProsima Fast DDS* does not compile tests. To activate them, please refer to the :ref:`linux_sources` page. - To use the :ref:`cli_xml` validation tool, please refer to the :ref:`linux_sources` page. - .. _contents_bl: Contents @@ -97,6 +95,24 @@ For example in order to build the examples dynamically linked to **Fast-DDS** do $ cmake -Bbuildexample -DBUILD_SHARED_LIBS=ON . $ cmake --build buildexample --target install +.. _cli_bl: + +Fast DDS CLI (optional) +----------------------- + +The :ref:`Fast DDS CLI` (Command Line Interface) is a tool that provides a set commands and +sub-commands to perform, Fast DDS related, maintenance and configuration tasks. +As an optional tool, its dependencies are not installed by default, but they can be installed by running the +following command: + +.. code-block:: bash + + sudo apt-get install python3 python3-pip + pip3 install xmlschema + +Python3 is required to run the CLI tool, and the `xmlschema `_ dependency is +needed to use the :ref:`XML validation command`. + .. _uninstall_bl: Uninstall diff --git a/docs/installation/binaries/binaries_windows.rst b/docs/installation/binaries/binaries_windows.rst index d69f377c4..4f2e7c956 100644 --- a/docs/installation/binaries/binaries_windows.rst +++ b/docs/installation/binaries/binaries_windows.rst @@ -129,3 +129,22 @@ For example in order to build the examples dynamically linked to **Fast-DDS** do > cmake -Bbuildexample -DBUILD_SHARED_LIBS=ON . > cmake --build buildexample --target install + + +.. _cli_bw: + +Fast DDS CLI (optional) +----------------------- + +The :ref:`Fast DDS CLI` (Command Line Interface) is a tool that provides a set commands and +sub-commands to perform, Fast DDS related, maintenance and configuration tasks. +As an optional tool, its dependencies are not installed by default, but they can be installed by running the +following command: + +.. code-block:: bash + + choco install python + python -m pip install --upgrade pywin32 xmlschema + +Python3 is required to run the CLI tool, and the `xmlschema `_ dependency is +needed to use the :ref:`XML validation command`.