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

Doxygen configuration & deploy to github pages #7

Merged
merged 5 commits into from
Dec 4, 2023
Merged

Doxygen configuration & deploy to github pages #7

merged 5 commits into from
Dec 4, 2023

Conversation

bkueng
Copy link
Collaborator

@bkueng bkueng commented Nov 28, 2023

@hamishwillee I was playing a bit with doxygen and we can add something automated with minimal effort that I think can be useful.
This is how it looks like: https://auterion.github.io/px4-ros2-interface-lib/modules.html

Let me know what you think.

@hamishwillee
Copy link

I think it is useful as is. A few comments for easy-wins.

  1. A cross link to the PX4 docs.
  2. The modules section lists https://auterion.github.io/px4-ros2-interface-lib/group__Setpoints.html under controls. Other experimental setpoint types are not listed here, but are in the class list - such as https://auterion.github.io/px4-ros2-interface-lib/classpx4__ros2_1_1AttitudeSetpointType.html
    • Would be good to indicate what is experimental in these docs to reduce confusion - a note or similar on the experimental things
    • Would be good to make it clear in the modules section that this is not the only setpoint, just only the supported setpoint.
  3. Make the name match the docs "Interface Library"
  4. "Here is a list of all modules:" - again make it clear what is in library and what it means not to be here but in the class list.

@bkueng
Copy link
Collaborator Author

bkueng commented Nov 29, 2023

I added the rest of it as well: https://auterion.github.io/px4-ros2-interface-lib/modules.html

The 'Here is a list of all modules' I cannot change - at least not easily. But it should contain all the directly usable classes & methods.

@bkueng bkueng marked this pull request as ready for review November 29, 2023 14:17
Copy link

@hamishwillee hamishwillee left a comment

Choose a reason for hiding this comment

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

Looks good. We can cross link from the docs next week.

@bkueng bkueng merged commit 8772aa9 into main Dec 4, 2023
5 checks passed
@bkueng bkueng deleted the doxygen branch December 4, 2023 07:51
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