Enable document generation using rosdoc2 for ament_python pkgs

[Yadunund]

Fix missing exec_depends in package.xmls and docstrings to generate documentation without any warnings using autodoc

[clalancette]

Hm, this one shouldn't be necessary; this is strictly a python package, so the tf2_ros_py dependency should be enough. The same goes for a few places below.

[Yadunund]

Thanks for the review! I've moved tf2_ros to <doc_depend>. I understand now that the tf2_ros_py module is imported as tf2_ros for backwards compatibility.

The sphinx_builder.py script also needs this patch Yadunund/rosdoc2@226f905 to include <doc_depends> into the autodoc_mock_imports list. I've updated the Checklist in rosdoc2 to ensure we land this patch.

[clalancette]

I've moved tf2_ros to <doc_depend>

Out of curiousity, why did you choose this route rather than a custom conf.py? I'm fine with either solution, but I do think we should expand the comment a bit to explain that modules import tf2_ros while the package is named tf2_ros_py.

[Yadunund]

To my knowledge even with a custom conf.py file, autodoc will complain that it cannot import tf2_ros when documenting such modules.

In my latest commit, I added custom rosdoc2.yaml + sphinx source files to tf2_ros_py. We now have documentaion for python tf2_ros module 🎉

[clalancette]

CI:

• Linux
• Linux-aarch64
• Windows