Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[21319] Add python optional step in binary installation sections (backport #853) #861

Merged
merged 1 commit into from
Jul 10, 2024
Merged

[21319] Add python optional step in binary installation sections (backport #853) #861

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions docs/installation/binaries/binaries_linux.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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<ffastddscli_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 <https://pypi.org/project/xmlschema/>`_ dependency is
needed to use the :ref:`XML validation command<cli_xml>`.

.. _uninstall_bl:

Uninstall
Expand Down
19 changes: 19 additions & 0 deletions docs/installation/binaries/binaries_windows.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<ffastddscli_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 <https://pypi.org/project/xmlschema/>`_ dependency is
needed to use the :ref:`XML validation command<cli_xml>`.
Loading