diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 00000000000..7faac1b9402 --- /dev/null +++ b/.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 + \ No newline at end of file diff --git a/.github/workflows/docker-image.yml b/.github/workflows/docker-image.yml index c7c042d1f00..e1bfd57b284 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 622303411ac..8eda3c9ed58 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 @@ -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 diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 00000000000..a44b07cec04 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,4 @@ +[submodule "source/_gitmodules/ros_tutorials"] + path = source/_gitmodules/ros_tutorials + url = git@github.com:ros/ros_tutorials.git + branch = rolling 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 diff --git a/README.md b/README.md index 27420b9c519..0bdc08021aa 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/conf.py b/conf.py index 0532287d682..179c0a773dd 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/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 . 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..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:: 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