Skip to content

Commit

Permalink
Improve python bindings documentation (#728)
Browse files Browse the repository at this point in the history
Signed-off-by: JesusPoderoso <[email protected]>
  • Loading branch information
JesusPoderoso authored May 7, 2024
1 parent 4061a9e commit 4128a38
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/fastddsgen/python_bindings/python_bindings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ Calling *eProsima Fast DDS-Gen* with the option `-python` will generate these fi
first generating C++ files (for connecting C++ and Python) and Python files (Python module for your type) and
then compiling the C++ sources.

.. note::

The Python bindings does not support the use of namespaces.

Before calling CMake, the :ref:`fastddsgen_python_build` process needs several :ref:`fastddsgen_python_deps` to be met.

.. _fastddsgen_python_deps:
Expand Down Expand Up @@ -45,6 +49,11 @@ Call CMake:
This will create the Python files (`.py`) with the modules (one per each IDL file) that have to be imported within the
Python script.

.. note::

The python bindings does not support using different modules in the same idl file.
Split them in different files for expected behavior.

.. External links
.. _SWIG: http://www.swig.org/

0 comments on commit 4128a38

Please sign in to comment.