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

Switch to use standard rosdoc2 instead of custom ament_cmake_doxygen #265

Open
tfoote opened this issue May 31, 2022 · 3 comments
Open

Switch to use standard rosdoc2 instead of custom ament_cmake_doxygen #265

tfoote opened this issue May 31, 2022 · 3 comments
Assignees

Comments

@tfoote
Copy link
Collaborator

tfoote commented May 31, 2022

We'd rather not rely on the non-upstream tool. It was a workaround for building docs locally for now.

We'll need to replace this before we have successful public builds of docs on the ros2 buildfarm.

@francocipollone
Copy link
Collaborator

Can I move this issue directly to maliput_infrastructure(or even maliput_documentation) as this affects all the repositories?

@tfoote
Copy link
Collaborator Author

tfoote commented Jun 1, 2022

Sure, I just filed it here as this package needed a fix.

@francocipollone francocipollone transferred this issue from maliput/maliput Jun 2, 2022
@francocipollone
Copy link
Collaborator

We are currently relying on ament_cmake_doxygen for documentation creation.
One convenient feature of this tool is that, when building documentation for a package, one can indicate to consume the generated documentation for the upstream's packages in a way that the linking between documentations of different repositories can be handled.

Example: when building documentation up-to maliput_malidrive, if I go to maliput_maldrive docs, I will find valid links to maliput package docs.
maliput_documentation takes advantage of this, being the package that gathers the documentation of all the repos.

rosdocs2 seems to be great for generating documentation for single packages, and certainly using this standard tool will be great, however my only concern is about linking properly linking to upstream docs for easier doc exploration.

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

No branches or pull requests

2 participants