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

Create a colcon extension for building documentation #15

Open
clalancette opened this issue Mar 10, 2021 · 1 comment
Open

Create a colcon extension for building documentation #15

clalancette opened this issue Mar 10, 2021 · 1 comment

Comments

@clalancette
Copy link
Contributor

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
Copy link

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

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