docs: add basic Sphinx doc skeleton for launch_xml and launch_yaml #933
Conversation
This file contains hidden or 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
- Add doc/conf.py and doc/index.rst for both packages - Include README via rosdoc2's standard_docs and API modules - Link to ROS 2 launch file formats how-to guide Signed-off-by: lsy3 <sylukewicent@gmail.com>
Signed-off-by: lsy3 <sylukewicent@gmail.com>
ahcorde
requested changes
Nov 27, 2025
| @@ -0,0 +1,22 @@ | |||
| # Copyright 2019 Open Source Robotics Foundation, Inc. | |||
Contributor
There was a problem hiding this comment.
Suggested change
| # Copyright 2019 Open Source Robotics Foundation, Inc. | |
| # Copyright 2025 Open Source Robotics Foundation, Inc. |
| @@ -0,0 +1,22 @@ | |||
| # Copyright 2019 Open Source Robotics Foundation, Inc. | |||
Contributor
There was a problem hiding this comment.
Suggested change
| # Copyright 2019 Open Source Robotics Foundation, Inc. | |
| # Copyright 2025 Open Source Robotics Foundation, Inc. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Description
Add basic Sphinx documentation skeleton for
launch_xmlandlaunch_yamlpackages.doc/conf.pyanddoc/index.rstfor both packagesFixes #929
Did you use Generative AI?
Cursor AI Assistant for scaffolding and iteration. Each generated line reviewed.
Additional Information
rosdoc2 build --package-path src/ros2/launch/launch_xmlandrosdoc2 build --package-path src/ros2/launch/launch_yaml.