From 4128a380b2c138c7d89a7df18536cacbdd3f35ed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jes=C3=BAs=20Poderoso?= <120394830+JesusPoderoso@users.noreply.github.com> Date: Tue, 7 May 2024 16:24:58 +0200 Subject: [PATCH] Improve python bindings documentation (#728) Signed-off-by: JesusPoderoso --- docs/fastddsgen/python_bindings/python_bindings.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/fastddsgen/python_bindings/python_bindings.rst b/docs/fastddsgen/python_bindings/python_bindings.rst index db0832eae..0fc604887 100644 --- a/docs/fastddsgen/python_bindings/python_bindings.rst +++ b/docs/fastddsgen/python_bindings/python_bindings.rst @@ -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: @@ -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/