Add COLCON_IGNORE to the generated documentation?

ros-infrastructure / rosdoc2

Command-line tool for generating documentation for ROS 2 packages.

Apache License 2.0

29 stars 9 forks source link

Add COLCON_IGNORE to the generated documentation? #125

Open damien-robotsix opened 3 weeks ago

damien-robotsix commented 3 weeks ago

I don't know if it is a wrong usage I make but the created documentation files appear in my ros2_workspace. When I try to colcon build again it complains about duplicate packages names since they are also found in the documentation.

A simple COLCON_IGNORE file would avoid that I think.

rkent commented 2 weeks ago

Can you please give the full path to the documentation folders that are detected as duplicate packages by colcon?

damien-robotsix commented 2 weeks ago

In my ROS workspace it got

ERROR:colcon:colcon build: Duplicate package names not supported:

_packagename:
- docs_build/package_name/package_name/wrapped_sphinx_directory/standard_docs/original
- src/package_name
I was working on a custom package but using default rosdoc2 configuration.