Create a colcon extension for building documentation

ros-infrastructure / rosdoc2

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

Apache License 2.0

29 stars 9 forks source link

Create a colcon extension for building documentation #15

Open clalancette opened 3 years ago

clalancette commented 3 years ago

It would be nice if users could just use colcon to build the documentation for all of the packages in their workspace. This will likely require a new colcon verb (colcon doc), along with the appropriate backend to call out to rosdoc2 to generate the documentation.

mikepurvis commented 7 months ago

We have the bones of a colcon-document verb (basically just a port of https://github.com/mikepurvis/catkin_tools_document) though currently it just invokes doxygen and sphinx directly, eg it's the ROS 1 rosdoc behaviour rather than interacting with rosdoc2. If there's interest from the community in collaborating, we can likely share our work-in-progress.

FYI @guillaumeautran