search

ros-infrastructure / rosdoc2

Command-line tool for generating documentation for ROS 2 packages.
Apache License 2.0
29 stars 9 forks source link

Duplicated output upon rebuild #32

Open hidmic opened 2 years ago

hidmic commented 2 years ago

Rebuilding a package's documentation with rosdoc2 build using the same build and cross-reference directories induces duplication warnings. These warnings go away after nuking said directories.

Should rosdoc2 do some housekeeping before generating output?

clalancette commented 2 years ago

Should rosdoc2 do some housekeeping before generating output?

Yeah, I'd be on board with that. Though we have to be careful to only do that housekeeping on very specific directories; we want users to invoke rosdoc2 several times on different packages to build up a whole database of API documentation.

aprotyas commented 2 years ago

Housekeeping in the sense that if rosdoc2 build --package-path P --build-directory B --cross-reference-directory C were invoked, we'd want to prune B/P and C/P given they exist, right? If so, that sounds reasonable.

hidmic commented 2 years ago

@aprotyas right, that'd be an option. I haven't dug enough to know how much can be reused.

aprotyas commented 2 years ago

Yes, it would be nice to re-use some things. IIRC, the doxygen artifacts (XML tags, etc.) don't get duplicated.