ros2_documentation icon indicating copy to clipboard operation
ros2_documentation copied to clipboard
verified publisher icon ros2

Inline Code Docs with Submodules

Open InvincibleRMC opened this issue 3 months ago • 2 comments

Description

Sets up the infrastructure by replacing a copied file with a submodule which hosted the duplicated file.

Fixes #5839

Did you use Generative AI?

Additional Information

Dependabot I think will also need to be enable in the repo or maybe org settings aswell.

The only difference in the output is it now includes the license information in the docs. If this isn't wanted I can add a block around the specific code in the turtlesim launch file.

InvincibleRMC avatar Oct 09 '25 01:10 InvincibleRMC

This will also need an update to the ros2doc build job to recursively clone. (Which I still need to find where it lives)

I think it happens here: https://github.com/ros-infrastructure/ros_buildfarm/blob/ff7c1cf38362d9fecae8ef2b677719e2d8ddc04b/ros_buildfarm/templates/doc/doc_independent_docker_job.xml.em#L96-L104

sloretz avatar Oct 09 '25 15:10 sloretz

Thanks!

Have opened a pr to make the clone recursive https://github.com/ros-infrastructure/ros_buildfarm/pull/1102

InvincibleRMC avatar Oct 10 '25 02:10 InvincibleRMC