Skip to content

Commit

Permalink
Improve Gen python bindings documentation: generated files are not ac…
Browse files Browse the repository at this point in the history
…tually created (#639)

* doc: Modify an generated files in document that is not actually created

Helloworld.py is not generated by FastDDSGen, by cmake and make.

Signed-off-by: Seong Jin Kim <mirusu400@naver.com>

* Update docs/fastdds/getting_started/simple_python_app/includes/dataType.rst

Co-authored-by: Jesús Poderoso <120394830+JesusPoderoso@users.noreply.github.com>
Signed-off-by: Seong Jin Kim <mirusu400@naver.com>

* Update docs/fastdds/getting_started/simple_python_app/includes/dataType.rst

Co-authored-by: Jesús Poderoso <120394830+JesusPoderoso@users.noreply.github.com>
Signed-off-by: Seong Jin Kim <mirusu400@naver.com>

---------

Signed-off-by: Seong Jin Kim <mirusu400@naver.com>
Co-authored-by: Jesús Poderoso <120394830+JesusPoderoso@users.noreply.github.com>
  • Loading branch information
mirusu400 and JesusPoderoso committed Jan 29, 2024
1 parent 5de9f3c commit a4261b1
Showing 1 changed file with 10 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,16 @@ This must have generated the following files:
* HelloWorldCdrAux.hpp: C++ header file for HelloWorldCdrAux.ipp.
* CMakeLists.txt: CMake file to generate C++ source code and Python module from the `SWIG`_ interface files,
compile and generate C++ libraries.

After that, the python bindings can be generated by running the following command.

.. code-block:: bash
cmake .
make
This must have generated the python binding:

* HelloWorld.py: Python module to be imported by your Python example.

CMakeLists.txt
Expand Down

0 comments on commit a4261b1

Please sign in to comment.