Add guide on creating package docs (backport #4196) #4237
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![mergify[bot]](https://avatars.githubusercontent.com/in/10562?s=60&v=4){kind=small}
* Add guide on creating package API docs Signed-off-by: Jonas Otto <[email protected]> Co-authored-by: Chris Lalancette <[email protected]> (cherry picked from commit 84dd416)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a guide to (creating) package documentation for ros 2 packages.
It's cobbled together from my own blog, the ros2 cookbook of @mikeferguson and the rosdoc2 readme (and source code).
Suggestions and contributions are very welcome.
The idea is to gather on this page all the required information to produce a docs page containing api docs for any supported language and written documentation in a way that is supported by the ros buildfarm for hosting on
https://docs.ros.org/<language>/<distro>/p/<package>/This is an automatic backport of pull request #4196 done by [Mergify](https://mergify.com).