From 1164fd89bc4afb7894a4df9989300879044b6f71 Mon Sep 17 00:00:00 2001 From: Michael Carlstrom Date: Wed, 8 Oct 2025 17:29:20 -0700 Subject: [PATCH 01/10] Added submod Signed-off-by: Michael Carlstrom --- .gitmodules | 3 +++ README.md | 6 ++++++ modules/ros_tutorials | 1 + .../Launching-Multiple-Nodes/Launching-Multiple-Nodes.rst | 2 +- 4 files changed, 11 insertions(+), 1 deletion(-) create mode 100644 .gitmodules create mode 160000 modules/ros_tutorials diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 00000000000..3c7ae556df9 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "modules/ros_tutorials"] + path = modules/ros_tutorials + url = git@github.com:ros/ros_tutorials.git diff --git a/README.md b/README.md index 3dffb339573..86cc627029b 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,12 @@ To contribute to the ROS 2 source code project please refer to the [ROS 2 contri ## Prerequisites +First clone this repo and its submodules. + +```console +git clone --recursive git@github.com:ros2/ros2_documentation.git +``` + To build this you need to install * make diff --git a/modules/ros_tutorials b/modules/ros_tutorials new file mode 160000 index 00000000000..857bd084eaa --- /dev/null +++ b/modules/ros_tutorials @@ -0,0 +1 @@ +Subproject commit 857bd084eaad9bd38bc3db1d4433afbcf334a529 diff --git a/source/Tutorials/Beginner-CLI-Tools/Launching-Multiple-Nodes/Launching-Multiple-Nodes.rst b/source/Tutorials/Beginner-CLI-Tools/Launching-Multiple-Nodes/Launching-Multiple-Nodes.rst index 52da78b1dad..74822c483a2 100644 --- a/source/Tutorials/Beginner-CLI-Tools/Launching-Multiple-Nodes/Launching-Multiple-Nodes.rst +++ b/source/Tutorials/Beginner-CLI-Tools/Launching-Multiple-Nodes/Launching-Multiple-Nodes.rst @@ -54,7 +54,7 @@ Open a new terminal and run: This command will run the following launch file: -.. literalinclude:: launch/multisim.launch.py +.. literalinclude:: modules/ros_tutorials/turtlesim/launch/multisim.launch.py :language: python .. note:: From 3e9be9028ba7eac910e26b66702561c90f41640d Mon Sep 17 00:00:00 2001 From: Michael Carlstrom Date: Wed, 8 Oct 2025 18:16:43 -0700 Subject: [PATCH 02/10] test complete Signed-off-by: Michael Carlstrom --- .github/dependabot.yml | 12 ++++++++++++ .gitmodules | 4 ++-- conf.py | 3 ++- .../Launching-Multiple-Nodes.rst | 2 +- .../launch/multisim.launch.py | 13 ------------- source/_gitmodules/ros_tutorials | 1 + 6 files changed, 18 insertions(+), 17 deletions(-) create mode 100644 .github/dependabot.yml delete mode 100644 source/Tutorials/Beginner-CLI-Tools/Launching-Multiple-Nodes/launch/multisim.launch.py create mode 160000 source/_gitmodules/ros_tutorials diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 00000000000..f86f21c4aca --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,12 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for all configuration options: +# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file + +version: 2 +updates: + - package-ecosystem: "gitsubmodule" # See documentation for possible values + directory: "/" # Location of package manifests + schedule: + interval: "weekly" + open-pull-requests-limit: 5 \ No newline at end of file diff --git a/.gitmodules b/.gitmodules index 3c7ae556df9..fe5d0181a6e 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,3 @@ -[submodule "modules/ros_tutorials"] - path = modules/ros_tutorials +[submodule "source/_gitmodules/ros_tutorials"] + path = source/_gitmodules/ros_tutorials url = git@github.com:ros/ros_tutorials.git diff --git a/conf.py b/conf.py index 1754ea079e9..3e2fe83dcb6 100644 --- a/conf.py +++ b/conf.py @@ -70,7 +70,8 @@ # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ['**/_*.rst'] +exclude_patterns = ['**/_*.rst', + '_gitmodules/**'] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' diff --git a/source/Tutorials/Beginner-CLI-Tools/Launching-Multiple-Nodes/Launching-Multiple-Nodes.rst b/source/Tutorials/Beginner-CLI-Tools/Launching-Multiple-Nodes/Launching-Multiple-Nodes.rst index 74822c483a2..334e906a607 100644 --- a/source/Tutorials/Beginner-CLI-Tools/Launching-Multiple-Nodes/Launching-Multiple-Nodes.rst +++ b/source/Tutorials/Beginner-CLI-Tools/Launching-Multiple-Nodes/Launching-Multiple-Nodes.rst @@ -54,7 +54,7 @@ Open a new terminal and run: This command will run the following launch file: -.. literalinclude:: modules/ros_tutorials/turtlesim/launch/multisim.launch.py +.. literalinclude:: /_gitmodules/ros_tutorials/turtlesim/launch/multisim.launch.py :language: python .. note:: diff --git a/source/Tutorials/Beginner-CLI-Tools/Launching-Multiple-Nodes/launch/multisim.launch.py b/source/Tutorials/Beginner-CLI-Tools/Launching-Multiple-Nodes/launch/multisim.launch.py deleted file mode 100644 index c959572c114..00000000000 --- a/source/Tutorials/Beginner-CLI-Tools/Launching-Multiple-Nodes/launch/multisim.launch.py +++ /dev/null @@ -1,13 +0,0 @@ -from launch import LaunchDescription -import launch_ros.actions - - -def generate_launch_description(): - return LaunchDescription([ - launch_ros.actions.Node( - namespace='turtlesim1', package='turtlesim', - executable='turtlesim_node', output='screen'), - launch_ros.actions.Node( - namespace='turtlesim2', package='turtlesim', - executable='turtlesim_node', output='screen'), - ]) diff --git a/source/_gitmodules/ros_tutorials b/source/_gitmodules/ros_tutorials new file mode 160000 index 00000000000..857bd084eaa --- /dev/null +++ b/source/_gitmodules/ros_tutorials @@ -0,0 +1 @@ +Subproject commit 857bd084eaad9bd38bc3db1d4433afbcf334a529 From a4485867a3f76bd45f3e1f77b29ba9b42cbf1e32 Mon Sep 17 00:00:00 2001 From: Michael Carlstrom Date: Wed, 8 Oct 2025 18:28:02 -0700 Subject: [PATCH 03/10] recurisve test clone Signed-off-by: Michael Carlstrom --- .github/workflows/test.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 8a0c0e71f4d..2748b99bc78 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -8,6 +8,8 @@ jobs: steps: - name: Checkout uses: actions/checkout@v4 + with: + submodules: 'recursive' - name: Setup Python uses: actions/setup-python@v5 From 3280bf5a350b182380d327532083c1332e8158e1 Mon Sep 17 00:00:00 2001 From: Michael Carlstrom Date: Wed, 8 Oct 2025 18:31:05 -0700 Subject: [PATCH 04/10] clean up git modules Signed-off-by: Michael Carlstrom From 640cb8f1fa2291880389960f6d83b11679cca9df Mon Sep 17 00:00:00 2001 From: Michael Carlstrom Date: Wed, 8 Oct 2025 18:38:08 -0700 Subject: [PATCH 05/10] remove extra gitmodule Signed-off-by: Michael Carlstrom --- modules/ros_tutorials | 1 - 1 file changed, 1 deletion(-) delete mode 160000 modules/ros_tutorials diff --git a/modules/ros_tutorials b/modules/ros_tutorials deleted file mode 160000 index 857bd084eaa..00000000000 --- a/modules/ros_tutorials +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 857bd084eaad9bd38bc3db1d4433afbcf334a529 From 91faad10501fcc198672bdb913d2b49834f89dc6 Mon Sep 17 00:00:00 2001 From: Michael Carlstrom Date: Wed, 8 Oct 2025 18:41:14 -0700 Subject: [PATCH 06/10] Add submods to the rest of the jobs Signed-off-by: Michael Carlstrom --- .github/workflows/docker-image.yml | 1 + .github/workflows/test.yml | 6 ++++++ 2 files changed, 7 insertions(+) diff --git a/.github/workflows/docker-image.yml b/.github/workflows/docker-image.yml index 2e750b9cac6..2bfb8e90ec2 100644 --- a/.github/workflows/docker-image.yml +++ b/.github/workflows/docker-image.yml @@ -14,6 +14,7 @@ jobs: - name: Checkout uses: actions/checkout@v4 with: + submodules: 'recursive' fetch-depth: 0 # Fetch full history including branches and tags - name: Set up Docker Buildx diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 2748b99bc78..c6c5c1fcaca 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -30,6 +30,8 @@ jobs: steps: - name: Checkout uses: actions/checkout@v4 + with: + submodules: 'recursive' - name: Setup Python uses: actions/setup-python@v5 @@ -47,6 +49,8 @@ jobs: steps: - name: Checkout uses: actions/checkout@v4 + with: + submodules: 'recursive' - name: Setup Python uses: actions/setup-python@v5 @@ -65,6 +69,8 @@ jobs: steps: - name: Checkout uses: actions/checkout@v4 + with: + submodules: 'recursive' - name: Setup Python uses: actions/setup-python@v5 From 51db567be6bde38080172c5df1cccd5bf6052ae3 Mon Sep 17 00:00:00 2001 From: Michael Carlstrom Date: Wed, 8 Oct 2025 18:51:14 -0700 Subject: [PATCH 07/10] don't lint upstream packages Signed-off-by: Michael Carlstrom --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index f2d90d3a3a8..4ddf021d5d3 100644 --- a/Makefile +++ b/Makefile @@ -25,7 +25,7 @@ multiversion: Makefile @$(BUILD) -M $@ "$(SOURCE)" "$(OUT)" $(OPTS) lint: - ./sphinx-lint-with-ros source + ./sphinx-lint-with-ros source -i _gitmodules test: doc8 --ignore D001 --ignore-path build From 9c5412064783ee4b725c446594b08a0453fa3d65 Mon Sep 17 00:00:00 2001 From: Michael Carlstrom Date: Thu, 9 Oct 2025 20:29:26 -0700 Subject: [PATCH 08/10] Update .gitmodules Co-authored-by: Tomoya Fujita Signed-off-by: Michael Carlstrom --- .gitmodules | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitmodules b/.gitmodules index fe5d0181a6e..a44b07cec04 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,4 @@ [submodule "source/_gitmodules/ros_tutorials"] path = source/_gitmodules/ros_tutorials url = git@github.com:ros/ros_tutorials.git + branch = rolling From 90026d3a5c073f0af5982604e684da8520b8b262 Mon Sep 17 00:00:00 2001 From: Michael Carlstrom Date: Thu, 9 Oct 2025 20:32:28 -0700 Subject: [PATCH 09/10] make recursive clone for dev container Signed-off-by: Michael Carlstrom --- .../Contributing/Contributing-To-ROS-2-Documentation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.rst b/source/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.rst index 98124c8bc34..f60465470f3 100644 --- a/source/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.rst +++ b/source/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.rst @@ -316,7 +316,7 @@ Clone repository and start VS Code: .. code-block:: console - $ git clone https://github.com/ros2/ros2_documentation + $ git clone --recursive https://github.com/ros2/ros2_documentation $ cd ./ros2_documentation $ code . From 031c280a721927ea5b38ea3b1e27b7feb376634d Mon Sep 17 00:00:00 2001 From: Michael Carlstrom Date: Thu, 9 Oct 2025 20:35:45 -0700 Subject: [PATCH 10/10] add newline to dependabot Signed-off-by: Michael Carlstrom --- .github/dependabot.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index f86f21c4aca..7faac1b9402 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -9,4 +9,5 @@ updates: directory: "/" # Location of package manifests schedule: interval: "weekly" - open-pull-requests-limit: 5 \ No newline at end of file + open-pull-requests-limit: 5 + \ No newline at end of file