Skip to content

Conversation

@lsy3
Copy link

@lsy3 lsy3 commented Nov 27, 2025

Description

Add basic Sphinx documentation skeleton for launch_xml and launch_yaml packages.

  • Add doc/conf.py and doc/index.rst for both packages
  • Include README and API modules via rosdoc2
  • Link to ROS 2 launch file formats how-to guide

Fixes #929

Did you use Generative AI?

Cursor AI Assistant for scaffolding and iteration. Each generated line reviewed.

Additional Information

  • Tested locally with rosdoc2 build --package-path src/ros2/launch/launch_xml and rosdoc2 build --package-path src/ros2/launch/launch_yaml.
  • launch_xml and launch_yaml docs structure is slightly different from launch. Removed extra source folder and other Makefiles.

lsy3 added 2 commits November 27, 2025 12:18
- 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 <[email protected]>
@@ -0,0 +1,22 @@
# Copyright 2019 Open Source Robotics Foundation, Inc.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add basic doc skeleton for launch_xml/yaml frontends

2 participants