Skip to content

Commit baa84d1

Browse files
Add python optional step in binary installation sections (#853) (#863)
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> (cherry picked from commit 4fa7593) Co-authored-by: Jesús Poderoso <120394830+JesusPoderoso@users.noreply.github.com>
1 parent 171204c commit baa84d1

2 files changed

Lines changed: 37 additions & 2 deletions

File tree

docs/installation/binaries/binaries_linux.rst

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,6 @@ the :code:`install.sh` script with administrative privileges:
3232
By default, *eProsima Fast DDS* does not compile tests. To activate them, please refer to the :ref:`linux_sources`
3333
page.
3434

35-
To use the :ref:`cli_xml` validation tool, please refer to the :ref:`linux_sources` page.
36-
3735
.. _contents_bl:
3836

3937
Contents
@@ -91,6 +89,24 @@ For example in order to build the examples statically linked to **Fast-DDS** do:
9189
$ cmake -Bbuildexample -DFASTDDS_STATIC=ON .
9290
$ cmake --build buildexample --target install
9391
92+
.. _cli_bl:
93+
94+
Fast DDS CLI (optional)
95+
-----------------------
96+
97+
The :ref:`Fast DDS CLI<ffastddscli_cli>` (Command Line Interface) is a tool that provides a set commands and
98+
sub-commands to perform, Fast DDS related, maintenance and configuration tasks.
99+
As an optional tool, its dependencies are not installed by default, but they can be installed by running the
100+
following command:
101+
102+
.. code-block:: bash
103+
104+
sudo apt-get install python3 python3-pip
105+
pip3 install xmlschema
106+
107+
Python3 is required to run the CLI tool, and the `xmlschema <https://pypi.org/project/xmlschema/>`_ dependency is
108+
needed to use the :ref:`XML validation command<cli_xml>`.
109+
94110
.. _uninstall_bl:
95111

96112
Uninstall

docs/installation/binaries/binaries_windows.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,3 +100,22 @@ For example in order to build the examples statically linked to **Fast-DDS** do:
100100
101101
> cmake -Bbuildexample -DFASTDDS_STATIC=ON .
102102
> cmake --build buildexample --target install
103+
104+
105+
.. _cli_bw:
106+
107+
Fast DDS CLI (optional)
108+
-----------------------
109+
110+
The :ref:`Fast DDS CLI<ffastddscli_cli>` (Command Line Interface) is a tool that provides a set commands and
111+
sub-commands to perform, Fast DDS related, maintenance and configuration tasks.
112+
As an optional tool, its dependencies are not installed by default, but they can be installed by running the
113+
following command:
114+
115+
.. code-block:: bash
116+
117+
choco install python
118+
python -m pip install --upgrade pywin32 xmlschema
119+
120+
Python3 is required to run the CLI tool, and the `xmlschema <https://pypi.org/project/xmlschema/>`_ dependency is
121+
needed to use the :ref:`XML validation command<cli_xml>`.

0 commit comments

Comments
 (0)