sea-bass · sea-bass · Jul 25, 2024 · Jul 25, 2024 · Jul 25, 2024 · Jul 25, 2024
diff --git a/.github/workflows/format.yml b/.github/workflows/format.yml
@@ -11,5 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: 'true'
       - uses: actions/setup-python@v5
       - uses: pre-commit/[email protected]
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -26,6 +26,8 @@ jobs:
     steps:
       - name: Check out repository
         uses: actions/checkout@v4
+        with:
+          submodules: 'true'
       - name: Login to Docker Hub Registry
         uses: docker/login-action@v3
         with:
@@ -96,6 +98,8 @@ jobs:
     steps:
       - name: Check out repository
         uses: actions/checkout@v4
+        with:
+          submodules: 'true'
       - name: Login to Docker Hub Registry
         uses: docker/login-action@v3
         with:

diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "pyrobosim_ros"]
+	path = pyrobosim_ros
+	url = https://github.com/sea-bass/pyrobosim_ros.git
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -3,17 +3,23 @@ version: 2
 
 # Set the version of Python and other tools
 build:
-  os: ubuntu-22.04
+  os: ubuntu-24.04
   tools:
-    python: "3.10"
+    python: "3.12"
+
+# Ensure the ROS related submodules are included
+submodules:
+  include:
+    - pyrobosim_ros
+  recursive: true
 
 python:
   install:
     - requirements: docs/python_docs_requirements.txt
     - method: pip
       path: pyrobosim
     - method: pip
-      path: pyrobosim_ros
+      path: pyrobosim_ros/pyrobosim_ros
 
 # Build documentation in the Sphinx source directory
 sphinx:

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -22,7 +22,7 @@
 author = "Sebastian Castro"
 
 # The full version, including alpha/beta/rc tags
-version = release = "2.0.0"
+version = release = "3.0.0"
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/source/setup.rst b/docs/source/setup.rst
@@ -20,8 +20,23 @@ However, note that this will not include any of the ROS 2 or Task and Motion Pla
 Local Setup
 -----------
 
-If using ROS 2, clone this repo in a valid `ROS 2 workspace <https://docs.ros.org/en/jazzy/Tutorials/Beginner-Client-Libraries/Creating-A-Workspace/Creating-A-Workspace.html>`_.
-Otherwise, if running standalone, clone it wherever you would like.
+If running standalone, clone this repo wherever you would like.
+
+::
+
+    git clone https://github.com/sea-bass/pyrobosim_ros.git
+
+.. note::
+    If using ROS 2, clone this repo in a valid `ROS 2 workspace <https://docs.ros.org/en/jazzy/Tutorials/Beginner-Client-Libraries/Creating-A-Workspace/Creating-A-Workspace.html>`_.
+
+    Also, make sure to **include submodules**, as this is how the `ROS 2 interface <https://github.com/sea-bass/pyrobosim_ros>`_ is included.
+
+    ::
+
+        mkdir -p ~/my_workspace/src
+        cd ~/my_workspace/src
+        git clone --recurse-submodules https://github.com/sea-bass/pyrobosim_ros.git
+
 
 To set up your Python virtual environment, configure and run
 

diff --git a/pyrobosim/setup.py b/pyrobosim/setup.py
@@ -33,7 +33,7 @@ def get_files_in_folder(directory):
 
 setup(
     name=project_name,
-    version="2.0.0",
+    version="3.0.0",
     url="https://github.com/sea-bass/pyrobosim",
     author="Sebastian Castro",
     author_email="[email protected]",

diff --git a/pyrobosim_msgs/CMakeLists.txt b/pyrobosim_msgs/CMakeLists.txt
diff --git a/pyrobosim_msgs/action/ExecuteTaskAction.action b/pyrobosim_msgs/action/ExecuteTaskAction.action
diff --git a/pyrobosim_msgs/action/ExecuteTaskPlan.action b/pyrobosim_msgs/action/ExecuteTaskPlan.action
diff --git a/pyrobosim_msgs/msg/ActionExecutionOptions.msg b/pyrobosim_msgs/msg/ActionExecutionOptions.msg
diff --git a/pyrobosim_msgs/msg/ExecutionResult.msg b/pyrobosim_msgs/msg/ExecutionResult.msg
diff --git a/pyrobosim_msgs/msg/GoalPredicate.msg b/pyrobosim_msgs/msg/GoalPredicate.msg
diff --git a/pyrobosim_msgs/msg/GoalSpecification.msg b/pyrobosim_msgs/msg/GoalSpecification.msg
diff --git a/pyrobosim_msgs/msg/LocationState.msg b/pyrobosim_msgs/msg/LocationState.msg
diff --git a/pyrobosim_msgs/msg/ObjectState.msg b/pyrobosim_msgs/msg/ObjectState.msg
diff --git a/pyrobosim_msgs/msg/Path.msg b/pyrobosim_msgs/msg/Path.msg
diff --git a/pyrobosim_msgs/msg/RobotState.msg b/pyrobosim_msgs/msg/RobotState.msg
diff --git a/pyrobosim_msgs/msg/TaskAction.msg b/pyrobosim_msgs/msg/TaskAction.msg
diff --git a/pyrobosim_msgs/msg/TaskPlan.msg b/pyrobosim_msgs/msg/TaskPlan.msg
diff --git a/pyrobosim_msgs/msg/WorldState.msg b/pyrobosim_msgs/msg/WorldState.msg
diff --git a/pyrobosim_msgs/package.xml b/pyrobosim_msgs/package.xml
diff --git a/pyrobosim_msgs/srv/RequestWorldState.srv b/pyrobosim_msgs/srv/RequestWorldState.srv
diff --git a/pyrobosim_msgs/srv/SetLocationState.srv b/pyrobosim_msgs/srv/SetLocationState.srv
diff --git a/pyrobosim_ros b/pyrobosim_ros