[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable document generation using rosdoc2 for ament_python pkgs #359

Merged
merged 3 commits into from
Mar 13, 2023

Conversation

Yadunund
Copy link
Member

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

Note: Works for all pkgs here except launch_ros.

  File "/home/yadunund/ws_rolling/src/ros2/launch_ros/launch_ros/launch_ros/parameters_type.py", line 50, in <module>
    SomeSubstitutionsType_types_tuple +
TypeError: unsupported operand type(s) for +: 'SomeSubstitutionsType_types_tuple' and 'tuple'

Might be able to fid this if we modify the code to explictly cast tuple(SomeSubstitutionsType_types_tuple) as autodoc is unable to infer the type given that the dep modules are not imported.

Incomplete documentation will be generated as a result for launch_ros

Yadunund added 3 commits March 9, 2023 18:29
Signed-off-by: Yadunund <yadunund@openrobotics.org>
Signed-off-by: Yadunund <yadunund@openrobotics.org>
Signed-off-by: Yadunund <yadunund@openrobotics.org>
@clalancette
Copy link
Contributor

CI:

  • Linux Build Status
  • Linux-aarch64 Build Status
  • Windows Build Status

@clalancette clalancette merged commit 1d57793 into rolling Mar 13, 2023
@clalancette clalancette deleted the yadu/rosdoc2_deps branch March 13, 2023 12:53
@Yadunund Yadunund changed the title Enable document generation using rosdoc2 Enable document generation using rosdoc2 for ament_python pkgs Mar 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants