From d5db4b61b48a6221010907d3f885cb4ed2b22476 Mon Sep 17 00:00:00 2001 From: lsy3 Date: Thu, 27 Nov 2025 12:18:06 +1100 Subject: [PATCH 1/2] docs: add basic Sphinx doc skeleton for launch_xml and launch_yaml - 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 --- launch_xml/doc/conf.py | 22 ++++++++++++++++++++++ launch_xml/doc/index.rst | 22 ++++++++++++++++++++++ launch_yaml/doc/conf.py | 22 ++++++++++++++++++++++ launch_yaml/doc/index.rst | 22 ++++++++++++++++++++++ 4 files changed, 88 insertions(+) create mode 100644 launch_xml/doc/conf.py create mode 100644 launch_xml/doc/index.rst create mode 100644 launch_yaml/doc/conf.py create mode 100644 launch_yaml/doc/index.rst diff --git a/launch_xml/doc/conf.py b/launch_xml/doc/conf.py new file mode 100644 index 000000000..170ed90b9 --- /dev/null +++ b/launch_xml/doc/conf.py @@ -0,0 +1,22 @@ +# Copyright 2019 Open Source Robotics Foundation, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +"""Configuration file for the Sphinx documentation builder.""" + +import os +import sys + +# rosdoc2 copies this package's modules alongside conf.py, so add parent to path +sys.path.insert(0, os.path.abspath('.')) + diff --git a/launch_xml/doc/index.rst b/launch_xml/doc/index.rst new file mode 100644 index 000000000..28279bdc9 --- /dev/null +++ b/launch_xml/doc/index.rst @@ -0,0 +1,22 @@ +Welcome to launch_xml's documentation! +====================================== + +``launch_xml`` provides an XML frontend for the ROS 2 launch system. + +For usage details, see `Using XML, YAML, and Python for ROS 2 Launch Files +`_. + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + standard_docs/README + modules + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/launch_yaml/doc/conf.py b/launch_yaml/doc/conf.py new file mode 100644 index 000000000..170ed90b9 --- /dev/null +++ b/launch_yaml/doc/conf.py @@ -0,0 +1,22 @@ +# Copyright 2019 Open Source Robotics Foundation, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +"""Configuration file for the Sphinx documentation builder.""" + +import os +import sys + +# rosdoc2 copies this package's modules alongside conf.py, so add parent to path +sys.path.insert(0, os.path.abspath('.')) + diff --git a/launch_yaml/doc/index.rst b/launch_yaml/doc/index.rst new file mode 100644 index 000000000..4d0299256 --- /dev/null +++ b/launch_yaml/doc/index.rst @@ -0,0 +1,22 @@ +Welcome to launch_yaml's documentation! +======================================= + +``launch_yaml`` provides a YAML frontend for the ROS 2 launch system. + +For usage details, see `Using XML, YAML, and Python for ROS 2 Launch Files +`_. + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + standard_docs/README + modules + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` From e95d51bdf258796a86922da09d7cd19b453f7687 Mon Sep 17 00:00:00 2001 From: lsy3 Date: Thu, 27 Nov 2025 12:37:13 +1100 Subject: [PATCH 2/2] removed url to ros2 docs Signed-off-by: lsy3 --- launch_xml/doc/index.rst | 4 +--- launch_yaml/doc/index.rst | 4 +--- 2 files changed, 2 insertions(+), 6 deletions(-) diff --git a/launch_xml/doc/index.rst b/launch_xml/doc/index.rst index 28279bdc9..d62cb5675 100644 --- a/launch_xml/doc/index.rst +++ b/launch_xml/doc/index.rst @@ -2,9 +2,7 @@ Welcome to launch_xml's documentation! ====================================== ``launch_xml`` provides an XML frontend for the ROS 2 launch system. - -For usage details, see `Using XML, YAML, and Python for ROS 2 Launch Files -`_. +See the ROS 2 documentation for usage examples with XML, YAML, and Python launch files. .. toctree:: :maxdepth: 2 diff --git a/launch_yaml/doc/index.rst b/launch_yaml/doc/index.rst index 4d0299256..1636748ed 100644 --- a/launch_yaml/doc/index.rst +++ b/launch_yaml/doc/index.rst @@ -2,9 +2,7 @@ Welcome to launch_yaml's documentation! ======================================= ``launch_yaml`` provides a YAML frontend for the ROS 2 launch system. - -For usage details, see `Using XML, YAML, and Python for ROS 2 Launch Files -`_. +See the ROS 2 documentation for usage examples with XML, YAML, and Python launch files. .. toctree:: :maxdepth: 2