MoveIt Python Library: Migrate Pybind11 Docstrings to Header files

[peterdavidfagan]

Background

High Priority: the docstrings in their current form are fairly haphazard, it is important to complete this task.

Currently we define docstrings for the Python API within the source code for the pybind11 python bindings example. This task involves migrating the docstrings to header files.

Instructions

Follow up on this investigation by @JafarAbdi:

source

I think it will be difficult to maintain the docs in the bindings. So, I started playing with https://github.com/pybind/pybind11_mkdoc during the weekend to auto-generate the docs from the header files, I did also port the robot_state binding one JafarAbdi@85b1f99. What do you think of this (cc @rhaschke)? I'm more than happy to port the other files.

Another tool worth trying is https://github.com/sizmailov/pybind11-stubgen. I haven't used it, yet, though!

@JafarAbdi I am not sure if you wish to follow up on this issue yourself, I am posting here for tracking purposes. I think this should be addressed in a separate pr to the current one. What are your thoughts?

[github-actions]

This issue is being labeled as stale because it has been open 45 days with no activity. It will be automatically closed after another 45 days without follow-ups.

[github-actions]

This issue was closed because it has been stalled for 45 days with no activity.