Inline Code Docs with Submodules

.github/dependabot.yml

@@ -0,0 +1,13 @@
+# 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
+

.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

.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
@@ -28,6 +30,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+        with:
+          submodules: 'recursive'
 
       - name: Setup Python
         uses: actions/setup-python@v5
@@ -45,6 +49,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+        with:
+          submodules: 'recursive'
 
       - name: Setup Python
         uses: actions/setup-python@v5
@@ -63,6 +69,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+        with:
+          submodules: 'recursive'
 
       - name: Setup Python
         uses: actions/setup-python@v5

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "source/_gitmodules/ros_tutorials"]
+	path = source/_gitmodules/ros_tutorials
+	url = [email protected]:ros/ros_tutorials.git
+	branch = rolling

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

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 [email protected]:ros2/ros2_documentation.git
+```
+
 To build this you need to install
 
 * make

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'

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 .
 

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:: /_gitmodules/ros_tutorials/turtlesim/launch/multisim.launch.py
    :language: python
 
 .. note::