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

Describe script arguments in documentation #675

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

ijnek
Copy link
Member

@ijnek ijnek commented Jun 7, 2022

image

Simply describes the argument parsers for all scripts on the RTD page. A lot of the details are (only) described in bloom/Tutorials/FirstTimeRelease, but it'd be better to have the arguments described here. (and using autogeneration). This also reduces the amount of detail covered in the FirstTimeRelease tutorial.

This PR simply sets up the documentation to display the script arguments, and makes no attempt at cleaning up the current arguments so that they display nicely in the docs. I (or someone else) should clean up the docstrings so they display nicely on RTD in another PR.

Related: ros2/ros2_documentation#2357

ijnek added 2 commits June 7, 2022 15:40
Signed-off-by: Kenji Brameld <[email protected]>
Signed-off-by: Kenji Brameld <[email protected]>
@ijnek ijnek changed the title Describe scripts in documentation Describe script arguments in documentation Jun 7, 2022
ijnek added 2 commits June 7, 2022 16:52
Signed-off-by: Kenji Brameld <[email protected]>
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

Successfully merging this pull request may close these issues.

1 participant