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.

Sign up for GitHub

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

Jump to bottom

Enable document generation using rosdoc2 for ament_python pkgs #217

Merged
merged 1 commit into from
Mar 15, 2023
Merged

Enable document generation using rosdoc2 for ament_python pkgs #217

merged 1 commit into from
Mar 15, 2023

Conversation

Yadunund
Copy link
Member

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

@Yadunund
Add missing dep for sensor_msgs_py
20feded 
Signed-off-by: Yadunund <yadunund@openrobotics.org>
@Yadunund Yadunund requested a review from tfoote as a code owner March 10, 2023 18:13
@Yadunund Yadunund mentioned this pull request Mar 10, 2023
Closed
18 tasks
tfoote
tfoote requested changes Mar 10, 2023
View reviewed changes
Copy link
Contributor

@tfoote tfoote left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is only necessary for doc generation we should use the 'doc_depend' tag.

@clalancette
Copy link
Contributor

If this is only necessary for doc generation we should use the 'doc_depend' tag.

It turns out that it is a dependency here, we just forgot to add it in the past and got lucky since it is a transitive dependency as well. See

common_interfaces/sensor_msgs_py/sensor_msgs_py/point_cloud2.py

Line 45 in 4bac182

from std_msgs.msg import Header

@Yadunund Yadunund changed the title Enable document generation using rosdoc2 Enable document generation using rosdoc2 for ament_python pkgs Mar 13, 2023
@Yadunund Yadunund requested a review from tfoote March 13, 2023 17:03
@clalancette
Copy link
Contributor

CI:

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

@clalancette clalancette merged commit 2208f18 into rolling Mar 15, 2023
@clalancette clalancette deleted the yadu/rosdoc2_deps branch March 15, 2023 15:25
tfoote
tfoote approved these changes Mar 15, 2023
View reviewed changes
Copy link
Contributor

@tfoote tfoote left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In that case lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@clalancette clalancette clalancette approved these changes

@tfoote tfoote tfoote approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Yadunund @clalancette @tfoote