add and improve generated package readmes

ika-rwth-aachen · Oct 17, 2024 · 02c6848 · 02c6848
1 parent 3ac3608
commit 02c6848
Show file tree

Hide file tree

Showing 14 changed files with 310 additions and 120 deletions.
diff --git a/samples/ros2_cpp_all_pkg/README.md b/samples/ros2_cpp_all_pkg/README.md
@@ -4,59 +4,43 @@ TODO
 
 - [Container Images](#container-images)
 - [ros2_cpp_node](#ros2_cpp_node)
-- [Official Documentation](#official-documentation)
 
 
-## Container Images
+### Container Images
 
-| Description | Image | Command |
+| Description | Image:Tag | Default Command |
 | --- | --- | -- |
-| <TODO> | `<IMAGE_NAME:TAG` | `ros2 run ros2_cpp_all_pkg ros2_cpp_node` |
+|  |  |  |
 
 
 ## `ros2_cpp_node`
 
 ### Subscribed Topics
 
-<LINK_TO_PUBLIC_DOCUMENTATION_OR_TABLE_BELOW>
-
 | Topic | Type | Description |
 | --- | --- | --- |
-| `<TOPIC/NAME>` | `<PACKAGE>/msg/<MESSAGE_TYPE>` | \<DESCRIPTION\> |
+|  |  |  |
 
 ### Published Topics
 
-<LINK_TO_PUBLIC_DOCUMENTATION_OR_TABLE_BELOW>
-
 | Topic | Type | Description |
 | --- | --- | --- |
-| `<TOPIC/NAME>` | `<PACKAGE>/msg/<MESSAGE_TYPE>` | \<DESCRIPTION\> |
+|  |  |  |
 
 ### Services
 
-<LINK_TO_PUBLIC_DOCUMENTATION_OR_TABLE_BELOW>
-
 | Service | Type | Description |
 | --- | --- | --- |
-| `<SERVICE/NAME>` | `<PACKAGE>/srv/<SERVICE_TYPE>` | \<DESCRIPTION\> |
+|  |  |  |
 
 ### Actions
 
-<LINK_TO_PUBLIC_DOCUMENTATION_OR_TABLE_BELOW>
-
 | Action | Type | Description |
 | --- | --- | --- |
-| `<ACTION/NAME>` | `<PACKAGE>/action/<ACTION_TYPE>` | \<DESCRIPTION\> |
+|  |  |  |
 
 ### Parameters
 
-<LINK_TO_PUBLIC_DOCUMENTATION_OR_TABLE_BELOW>
-
 | Parameter | Type | Description |
 | --- | --- | --- |
-| `<PARAMETER/NAME>` | `<PARAMETER_TYPE>` | \<DESCRIPTION\> |
-
-
-## Official Documentation
-
-\<LINK_TO_PUBLIC_DOCUMENTATION>
+|  |  |  |
diff --git a/samples/ros2_cpp_all_pkg_interfaces/README.md b/samples/ros2_cpp_all_pkg_interfaces/README.md
@@ -0,0 +1,22 @@
+# ros2_cpp_all_pkg_interfaces
+
+ROS interface definitions for ros2_cpp_all_pkg
+
+
+### Messages
+
+| Type | Description |
+| --- | --- |
+|  |  |
+
+### Services
+
+| Type | Description |
+| --- | --- |
+|  |  |
+
+### Actions
+
+| Type | Description |
+| --- | --- |
+|  |  |
diff --git a/samples/ros2_cpp_component_pkg/README.md b/samples/ros2_cpp_component_pkg/README.md
@@ -4,59 +4,43 @@ TODO
 
 - [Container Images](#container-images)
 - [ros2_cpp_node](#ros2_cpp_node)
-- [Official Documentation](#official-documentation)
 
 
-## Container Images
+### Container Images
 
-| Description | Image | Command |
+| Description | Image:Tag | Default Command |
 | --- | --- | -- |
-| <TODO> | `<IMAGE_NAME:TAG` | `ros2 run ros2_cpp_component_pkg ros2_cpp_node` |
+|  |  |  |
 
 
 ## `ros2_cpp_node`
 
 ### Subscribed Topics
 
-<LINK_TO_PUBLIC_DOCUMENTATION_OR_TABLE_BELOW>
-
 | Topic | Type | Description |
 | --- | --- | --- |
-| `<TOPIC/NAME>` | `<PACKAGE>/msg/<MESSAGE_TYPE>` | \<DESCRIPTION\> |
+|  |  |  |
 
 ### Published Topics
 
-<LINK_TO_PUBLIC_DOCUMENTATION_OR_TABLE_BELOW>
-
 | Topic | Type | Description |
 | --- | --- | --- |
-| `<TOPIC/NAME>` | `<PACKAGE>/msg/<MESSAGE_TYPE>` | \<DESCRIPTION\> |
+|  |  |  |
 
 ### Services
 
-<LINK_TO_PUBLIC_DOCUMENTATION_OR_TABLE_BELOW>
-
 | Service | Type | Description |
 | --- | --- | --- |
-| `<SERVICE/NAME>` | `<PACKAGE>/srv/<SERVICE_TYPE>` | \<DESCRIPTION\> |
+|  |  |  |
 
 ### Actions
 
-<LINK_TO_PUBLIC_DOCUMENTATION_OR_TABLE_BELOW>
-
 | Action | Type | Description |
 | --- | --- | --- |
-| `<ACTION/NAME>` | `<PACKAGE>/action/<ACTION_TYPE>` | \<DESCRIPTION\> |
+|  |  |  |
 
 ### Parameters
 
-<LINK_TO_PUBLIC_DOCUMENTATION_OR_TABLE_BELOW>
-
 | Parameter | Type | Description |
 | --- | --- | --- |
-| `<PARAMETER/NAME>` | `<PARAMETER_TYPE>` | \<DESCRIPTION\> |
-
-
-## Official Documentation
-
-\<LINK_TO_PUBLIC_DOCUMENTATION>
+|  |  |  |
diff --git a/samples/ros2_cpp_lifecycle_pkg/README.md b/samples/ros2_cpp_lifecycle_pkg/README.md
@@ -4,59 +4,43 @@ TODO
 
 - [Container Images](#container-images)
 - [ros2_cpp_node](#ros2_cpp_node)
-- [Official Documentation](#official-documentation)
 
 
-## Container Images
+### Container Images
 
-| Description | Image | Command |
+| Description | Image:Tag | Default Command |
 | --- | --- | -- |
-| <TODO> | `<IMAGE_NAME:TAG` | `ros2 run ros2_cpp_lifecycle_pkg ros2_cpp_node` |
+|  |  |  |
 
 
 ## `ros2_cpp_node`
 
 ### Subscribed Topics
 
-<LINK_TO_PUBLIC_DOCUMENTATION_OR_TABLE_BELOW>
-
 | Topic | Type | Description |
 | --- | --- | --- |
-| `<TOPIC/NAME>` | `<PACKAGE>/msg/<MESSAGE_TYPE>` | \<DESCRIPTION\> |
+|  |  |  |
 
 ### Published Topics
 
-<LINK_TO_PUBLIC_DOCUMENTATION_OR_TABLE_BELOW>
-
 | Topic | Type | Description |
 | --- | --- | --- |
-| `<TOPIC/NAME>` | `<PACKAGE>/msg/<MESSAGE_TYPE>` | \<DESCRIPTION\> |
+|  |  |  |
 
 ### Services
 
-<LINK_TO_PUBLIC_DOCUMENTATION_OR_TABLE_BELOW>
-
 | Service | Type | Description |
 | --- | --- | --- |
-| `<SERVICE/NAME>` | `<PACKAGE>/srv/<SERVICE_TYPE>` | \<DESCRIPTION\> |
+|  |  |  |
 
 ### Actions
 
-<LINK_TO_PUBLIC_DOCUMENTATION_OR_TABLE_BELOW>
-
 | Action | Type | Description |
 | --- | --- | --- |
-| `<ACTION/NAME>` | `<PACKAGE>/action/<ACTION_TYPE>` | \<DESCRIPTION\> |
+|  |  |  |
 
 ### Parameters
 
-<LINK_TO_PUBLIC_DOCUMENTATION_OR_TABLE_BELOW>
-
 | Parameter | Type | Description |
 | --- | --- | --- |
-| `<PARAMETER/NAME>` | `<PARAMETER_TYPE>` | \<DESCRIPTION\> |
-
-
-## Official Documentation
-
-\<LINK_TO_PUBLIC_DOCUMENTATION>
+|  |  |  |
diff --git a/samples/ros2_cpp_pkg/README.md b/samples/ros2_cpp_pkg/README.md
@@ -4,59 +4,43 @@ TODO
 
 - [Container Images](#container-images)
 - [ros2_cpp_node](#ros2_cpp_node)
-- [Official Documentation](#official-documentation)
 
 
-## Container Images
+### Container Images
 
-| Description | Image | Command |
+| Description | Image:Tag | Default Command |
 | --- | --- | -- |
-| <TODO> | `<IMAGE_NAME:TAG` | `ros2 run ros2_cpp_pkg ros2_cpp_node` |
+|  |  |  |
 
 
 ## `ros2_cpp_node`
 
 ### Subscribed Topics
 
-<LINK_TO_PUBLIC_DOCUMENTATION_OR_TABLE_BELOW>
-
 | Topic | Type | Description |
 | --- | --- | --- |
-| `<TOPIC/NAME>` | `<PACKAGE>/msg/<MESSAGE_TYPE>` | \<DESCRIPTION\> |
+|  |  |  |
 
 ### Published Topics
 
-<LINK_TO_PUBLIC_DOCUMENTATION_OR_TABLE_BELOW>
-
 | Topic | Type | Description |
 | --- | --- | --- |
-| `<TOPIC/NAME>` | `<PACKAGE>/msg/<MESSAGE_TYPE>` | \<DESCRIPTION\> |
+|  |  |  |
 
 ### Services
 
-<LINK_TO_PUBLIC_DOCUMENTATION_OR_TABLE_BELOW>
-
 | Service | Type | Description |
 | --- | --- | --- |
-| `<SERVICE/NAME>` | `<PACKAGE>/srv/<SERVICE_TYPE>` | \<DESCRIPTION\> |
+|  |  |  |
 
 ### Actions
 
-<LINK_TO_PUBLIC_DOCUMENTATION_OR_TABLE_BELOW>
-
 | Action | Type | Description |
 | --- | --- | --- |
-| `<ACTION/NAME>` | `<PACKAGE>/action/<ACTION_TYPE>` | \<DESCRIPTION\> |
+|  |  |  |
 
 ### Parameters
 
-<LINK_TO_PUBLIC_DOCUMENTATION_OR_TABLE_BELOW>
-
 | Parameter | Type | Description |
 | --- | --- | --- |
-| `<PARAMETER/NAME>` | `<PARAMETER_TYPE>` | \<DESCRIPTION\> |
-
-
-## Official Documentation
-
-\<LINK_TO_PUBLIC_DOCUMENTATION>
+|  |  |  |
diff --git a/samples/ros2_interfaces_pkg/README.md b/samples/ros2_interfaces_pkg/README.md
@@ -0,0 +1,22 @@
+# ros2_interfaces_pkg
+
+TODO
+
+
+### Messages
+
+| Type | Description |
+| --- | --- |
+|  |  |
+
+### Services
+
+| Type | Description |
+| --- | --- |
+|  |  |
+
+### Actions
+
+| Type | Description |
+| --- | --- |
+|  |  |
diff --git a/samples/ros2_python_all_pkg/README.md b/samples/ros2_python_all_pkg/README.md
@@ -0,0 +1,46 @@
+# ros2_python_all_pkg
+
+TODO
+
+- [Container Images](#container-images)
+- [ros2_python_node](#ros2_python_node)
+
+
+### Container Images
+
+| Description | Image:Tag | Default Command |
+| --- | --- | -- |
+|  |  |  |
+
+
+## `ros2_python_node`
+
+### Subscribed Topics
+
+| Topic | Type | Description |
+| --- | --- | --- |
+|  |  |  |
+
+### Published Topics
+
+| Topic | Type | Description |
+| --- | --- | --- |
+|  |  |  |
+
+### Services
+
+| Service | Type | Description |
+| --- | --- | --- |
+|  |  |  |
+
+### Actions
+
+| Action | Type | Description |
+| --- | --- | --- |
+|  |  |  |
+
+### Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+|  |  |  |
diff --git a/samples/ros2_python_all_pkg_interfaces/README.md b/samples/ros2_python_all_pkg_interfaces/README.md
@@ -0,0 +1,22 @@
+# ros2_python_all_pkg_interfaces
+
+ROS interface definitions for ros2_python_all_pkg
+
+
+### Messages
+
+| Type | Description |
+| --- | --- |
+|  |  |
+
+### Services
+
+| Type | Description |
+| --- | --- |
+|  |  |
+
+### Actions
+
+| Type | Description |
+| --- | --- |
+|  |  |