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

Support only messages #78

Merged
merged 2 commits into from
Mar 28, 2024
Merged

Conversation

rkent
Copy link
Contributor

@rkent rkent commented Mar 27, 2024

This was less complex than I feared. Test case only_messages shows how this works.

I find the whole process of deciding what to run to be hard to understand. Here I change the decision to run breathe based on the existence of the doxygen output, while previously it was done based on build type. Both seem a little too much like black magic to me. I feel like it could use a refactoring, but maybe the complexity is just inherent and hard to improve.

Fixes #54

@rkent rkent requested review from audrow and tfoote as code owners March 27, 2024 20:06
Copy link
Member

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

Using the logic to run breathe if doxygen was run makes sense. It's specifically for integrating the doxygen content into a sphinx runner. The previous logic was a proxy for where we were expecting doxygen to be run. (Aka c++ build types) But directly detecting that there's content available makes sense and is likely more robust.

I've tested that this is working for packages known to be previously failing.

@tfoote tfoote merged commit 5b85766 into ros-infrastructure:main Mar 28, 2024
2 checks passed
@tfoote
Copy link
Member

tfoote commented Mar 28, 2024

@Yadunund
Copy link
Collaborator

🎉 🎉 🎉

@ros-discourse
Copy link

This pull request has been mentioned on ROS Discourse. There might be relevant details there:

https://discourse.ros.org/t/rosdoc2-undergoing-significant-change/36905/2

@ros-discourse
Copy link

This pull request has been mentioned on ROS Discourse. There might be relevant details there:

https://discourse.ros.org/t/plans-for-ros-2-documentation-particularly-api-docs/28638/23

@rkent rkent deleted the support-only-messages branch August 3, 2024 04:17
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.

message only packages are failing to generate documentation
4 participants