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 #811

Merged
merged 4 commits into from
Mar 13, 2023
Merged

Enable document generation using rosdoc2 for ament_python pkgs #811

merged 4 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: Without explictly casting HIDDEN_NODE_PREFIX to str, autodoc will throw an error as it cannot infer the type of this variable since dep modules are not imported.

@Yadunund
Fix warnings for ros2component
f24581b 
Signed-off-by: Yadunund <yadunund@openrobotics.org>
@Yadunund
Fix deps for ros2doctor and ros2interface
5fb7448 
Signed-off-by: Yadunund <yadunund@openrobotics.org>
@Yadunund
Fix dep for ros2node
e47eeba 
Signed-off-by: Yadunund <yadunund@openrobotics.org>
@Yadunund
Make type of HIDDEN_NODE_PREFIX explicit for sphinx
4438d65 
Signed-off-by: Yadunund <yadunund@openrobotics.org>
@Yadunund Yadunund mentioned this pull request Mar 10, 2023
Closed
18 tasks
clalancette
clalancette approved these changes Mar 10, 2023
View reviewed changes
Copy link
Contributor

@clalancette clalancette left a comment

Choose a reason for hiding this comment

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

This looks good to me.

@clalancette
Copy link
Contributor

CI:

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

@clalancette clalancette merged commit 7ba272c into rolling Mar 13, 2023
@clalancette clalancette deleted the yadu/rosdoc2_deps branch March 13, 2023 12:54
@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
Reviewers

@fujitatomoya fujitatomoya fujitatomoya approved these changes

@clalancette clalancette clalancette approved these changes

@audrow audrow Awaiting requested review from audrow audrow is a code owner

@gbiggs gbiggs Awaiting requested review from gbiggs gbiggs is a code owner

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 @fujitatomoya