Skip to content

Commit a582352

Browse files
Add python optional step in binary installation sections (#853) (#861)
Signed-off-by: JesusPoderoso <[email protected]> (cherry picked from commit 4fa7593) Co-authored-by: Jesús Poderoso <[email protected]>
1 parent 24c238d commit a582352

File tree

2 files changed

+37
-2
lines changed

2 files changed

+37
-2
lines changed

docs/installation/binaries/binaries_linux.rst

+18-2
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
@@ -97,6 +95,24 @@ For example in order to build the examples dynamically linked to **Fast-DDS** do
9795
$ cmake -Bbuildexample -DBUILD_SHARED_LIBS=ON .
9896
$ cmake --build buildexample --target install
9997
98+
.. _cli_bl:
99+
100+
Fast DDS CLI (optional)
101+
-----------------------
102+
103+
The :ref:`Fast DDS CLI<ffastddscli_cli>` (Command Line Interface) is a tool that provides a set commands and
104+
sub-commands to perform, Fast DDS related, maintenance and configuration tasks.
105+
As an optional tool, its dependencies are not installed by default, but they can be installed by running the
106+
following command:
107+
108+
.. code-block:: bash
109+
110+
sudo apt-get install python3 python3-pip
111+
pip3 install xmlschema
112+
113+
Python3 is required to run the CLI tool, and the `xmlschema <https://pypi.org/project/xmlschema/>`_ dependency is
114+
needed to use the :ref:`XML validation command<cli_xml>`.
115+
100116
.. _uninstall_bl:
101117

102118
Uninstall

docs/installation/binaries/binaries_windows.rst

+19
Original file line numberDiff line numberDiff line change
@@ -129,3 +129,22 @@ For example in order to build the examples dynamically linked to **Fast-DDS** do
129129
130130
> cmake -Bbuildexample -DBUILD_SHARED_LIBS=ON .
131131
> cmake --build buildexample --target install
132+
133+
134+
.. _cli_bw:
135+
136+
Fast DDS CLI (optional)
137+
-----------------------
138+
139+
The :ref:`Fast DDS CLI<ffastddscli_cli>` (Command Line Interface) is a tool that provides a set commands and
140+
sub-commands to perform, Fast DDS related, maintenance and configuration tasks.
141+
As an optional tool, its dependencies are not installed by default, but they can be installed by running the
142+
following command:
143+
144+
.. code-block:: bash
145+
146+
choco install python
147+
python -m pip install --upgrade pywin32 xmlschema
148+
149+
Python3 is required to run the CLI tool, and the `xmlschema <https://pypi.org/project/xmlschema/>`_ dependency is
150+
needed to use the :ref:`XML validation command<cli_xml>`.

0 commit comments

Comments
 (0)