refactor(autoware-interfaces): use jinja2 template for pages of Autow…

…are interfaces (autowarefoundation#372) * feat: add templates and macros Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp> * feat: update route api pages Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp> * feat: update template Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp> * feat: update localization api pages Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp> * feat: update api pages Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp> * feat: resolve field types Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp> * feat: add message link Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp> * feat: change yaml format Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp> * feat: generate type pages Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp> * feat: type page template Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp> * feat: update type pages Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp> * feat: update comment Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp> * docs: add readme Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp> * Update tools/autoware-interfaces/README.md Co-authored-by: M. Fatih Cırıt <xmfcx@users.noreply.github.com> * feat: fix spell check Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp> * feat: fix tool comment Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp> --------- Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp> Co-authored-by: M. Fatih Cırıt <xmfcx@users.noreply.github.com> Signed-off-by: guiping meng <alan.meng@autocore.ai>
alanmengg · Aug 2, 2023 · c767a38 · c767a38
1 parent 7f24cd6
commit c767a38
Show file tree

Hide file tree

Showing 66 changed files with 1,056 additions and 786 deletions.
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/fail_safe/mrm_state.md b/docs/design/autoware-interfaces/ad-api/list/api/fail_safe/mrm_state.md
@@ -1,17 +1,16 @@
-<!-- This file is generated by a tool. Do not edit directly. -->
-
-# /api/fail_safe/mrm_state
-
-- Method: notification
-- Type: [autoware_adapi_v1_msgs/msg/MrmState](../../../types/autoware_adapi_v1_msgs/msg/mrm_state.md)
-
-## Description
+---
+title: /api/fail_safe/mrm_state
+method: notification
+type:
+  name: autoware_adapi_v1_msgs/msg/MrmState
+  msg:
+    - name: state
+      text: The state of MRM operation.
+    - name: behavior
+      text: The currently selected behavior of MRM.
+---
 
+{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
+{% block description %}
 Get the MRM state. For details, see the [fail-safe](./index.md).
-
-## Message
-
-| Name     | Type   | Description                             |
-| -------- | ------ | --------------------------------------- |
-| state    | uint16 | The state of MRM operation.             |
-| behavior | uint16 | The currently selected behavior of MRM. |
+{% endblock %}
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/interface/version.md b/docs/design/autoware-interfaces/ad-api/list/api/interface/version.md
@@ -1,22 +1,18 @@
-<!-- This file is generated by a tool. Do not edit directly. -->
-
-# /api/interface/version
-
-- Method: function call
-- Type: [autoware_adapi_version_msgs/srv/InterfaceVersion](../../../types/autoware_adapi_version_msgs/srv/interface_version.md)
-
-## Description
-
+---
+title: /api/interface/version
+method: function call
+type:
+  name: autoware_adapi_version_msgs/srv/InterfaceVersion
+  res:
+    - name: major
+      text: major version
+    - name: minor
+      text: minor version
+    - name: patch
+      text: patch version
+---
+
+{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
+{% block description %}
 Get the interface version. The version follows Semantic Versioning.
-
-## Request
-
-None
-
-## Response
-
-| Name  | Type   | Description   |
-| ----- | ------ | ------------- |
-| major | uint16 | major version |
-| minor | uint16 | minor version |
-| patch | uint16 | patch version |
+{% endblock %}
diff --git a/...design/autoware-interfaces/ad-api/list/api/localization/initialization_state.md b/...design/autoware-interfaces/ad-api/list/api/localization/initialization_state.md
@@ -1,16 +1,14 @@
-<!-- This file is generated by a tool. Do not edit directly. -->
-
-# /api/localization/initialization_state
-
-- Method: notification
-- Type: [autoware_adapi_v1_msgs/msg/LocalizationInitializationState](../../../types/autoware_adapi_v1_msgs/msg/localization_initialization_state.md)
-
-## Description
-
+---
+title: /api/localization/initialization_state
+method: notification
+type:
+  name: autoware_adapi_v1_msgs/msg/LocalizationInitializationState
+  msg:
+    - name: state
+      text: A value of the [localization initialization state](./index.md).
+---
+
+{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
+{% block description %}
 Get the initialization state of localization. For details, see the [localization initialization state](./index.md).
-
-## Message
-
-| Name  | Type   | Description                                                     |
-| ----- | ------ | --------------------------------------------------------------- |
-| state | uint16 | A value of the [localization initialization state](./index.md). |
+{% endblock %}
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/localization/initialize.md b/docs/design/autoware-interfaces/ad-api/list/api/localization/initialize.md
@@ -1,22 +1,17 @@
-<!-- This file is generated by a tool. Do not edit directly. -->
-
-# /api/localization/initialize
-
-- Method: function call
-- Type: [autoware_adapi_v1_msgs/srv/InitializeLocalization](../../../types/autoware_adapi_v1_msgs/srv/initialize_localization.md)
-
-## Description
-
+---
+title: /api/localization/initialize
+method: function call
+type:
+  name: autoware_adapi_v1_msgs/srv/InitializeLocalization
+  req:
+    - name: pose
+      text: A global pose as the initial guess. If omitted, the GNSS pose will be used.
+  res:
+    - name: status
+      text: response status
+---
+
+{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
+{% block description %}
 Request to initialize localization. For details, see the [pose state](./index.md).
-
-## Request
-
-| Name | Type                                             | Description                                                                 |
-| ---- | ------------------------------------------------ | --------------------------------------------------------------------------- |
-| pose | geometry_msgs/msg/PoseWithCovarianceStamped[<=1] | A global pose as the initial guess. If omitted, the GNSS pose will be used. |
-
-## Response
-
-| Name   | Type                                      | Description     |
-| ------ | ----------------------------------------- | --------------- |
-| status | autoware_adapi_v1_msgs/msg/ResponseStatus | response status |
+{% endblock %}
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/motion/accept_start.md b/docs/design/autoware-interfaces/ad-api/list/api/motion/accept_start.md
@@ -1,20 +1,14 @@
-<!-- This file is generated by a tool. Do not edit directly. -->
-
-# /api/motion/accept_start
-
-- Method: function call
-- Type: [autoware_adapi_v1_msgs/srv/AcceptStart](../../../types/autoware_adapi_v1_msgs/srv/accept_start.md)
-
-## Description
-
+---
+title: /api/motion/accept_start
+method: function call
+type:
+  name: autoware_adapi_v1_msgs/srv/AcceptStart
+  res:
+    - name: status
+      text: response status
+---
+
+{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
+{% block description %}
 Accept the vehicle to start. This API can be used when the [motion state](./index.md) is STARTING.
-
-## Request
-
-None
-
-## Response
-
-| Name   | Type                                      | Description     |
-| ------ | ----------------------------------------- | --------------- |
-| status | autoware_adapi_v1_msgs/msg/ResponseStatus | response status |
+{% endblock %}
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/motion/state.md b/docs/design/autoware-interfaces/ad-api/list/api/motion/state.md
@@ -1,16 +1,14 @@
-<!-- This file is generated by a tool. Do not edit directly. -->
-
-# /api/motion/state
-
-- Method: notification
-- Type: [autoware_adapi_v1_msgs/msg/MotionState](../../../types/autoware_adapi_v1_msgs/msg/motion_state.md)
-
-## Description
-
+---
+title: /api/motion/state
+method: notification
+type:
+  name: autoware_adapi_v1_msgs/msg/MotionState
+  msg:
+    - name: state
+      text: A value of the motion state.
+---
+
+{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
+{% block description %}
 Get the motion state. For details, see the [motion state](./index.md).
-
-## Message
-
-| Name  | Type   | Description                  |
-| ----- | ------ | ---------------------------- |
-| state | uint16 | A value of the motion state. |
+{% endblock %}
diff --git a/...sign/autoware-interfaces/ad-api/list/api/operation_mode/change_to_autonomous.md b/...sign/autoware-interfaces/ad-api/list/api/operation_mode/change_to_autonomous.md
@@ -1,20 +1,14 @@
-<!-- This file is generated by a tool. Do not edit directly. -->
-
-# /api/operation_mode/change_to_autonomous
-
-- Method: function call
-- Type: [autoware_adapi_v1_msgs/srv/ChangeOperationMode](../../../types/autoware_adapi_v1_msgs/srv/change_operation_mode.md)
-
-## Description
-
+---
+title: /api/operation_mode/change_to_autonomous
+method: function call
+type:
+  name: autoware_adapi_v1_msgs/srv/ChangeOperationMode
+  res:
+    - name: status
+      text: response status
+---
+
+{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
+{% block description %}
 Change the operation mode to autonomous. For details, see the [operation mode](./index.md).
-
-## Request
-
-None
-
-## Response
-
-| Name   | Type                                      | Description     |
-| ------ | ----------------------------------------- | --------------- |
-| status | autoware_adapi_v1_msgs/msg/ResponseStatus | response status |
+{% endblock %}
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/operation_mode/change_to_local.md b/docs/design/autoware-interfaces/ad-api/list/api/operation_mode/change_to_local.md
@@ -1,20 +1,14 @@
-<!-- This file is generated by a tool. Do not edit directly. -->
-
-# /api/operation_mode/change_to_local
-
-- Method: function call
-- Type: [autoware_adapi_v1_msgs/srv/ChangeOperationMode](../../../types/autoware_adapi_v1_msgs/srv/change_operation_mode.md)
-
-## Description
-
+---
+title: /api/operation_mode/change_to_local
+method: function call
+type:
+  name: autoware_adapi_v1_msgs/srv/ChangeOperationMode
+  res:
+    - name: status
+      text: response status
+---
+
+{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
+{% block description %}
 Change the operation mode to local. For details, see the [operation mode](./index.md).
-
-## Request
-
-None
-
-## Response
-
-| Name   | Type                                      | Description     |
-| ------ | ----------------------------------------- | --------------- |
-| status | autoware_adapi_v1_msgs/msg/ResponseStatus | response status |
+{% endblock %}
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/operation_mode/change_to_remote.md b/docs/design/autoware-interfaces/ad-api/list/api/operation_mode/change_to_remote.md
@@ -1,20 +1,14 @@
-<!-- This file is generated by a tool. Do not edit directly. -->
-
-# /api/operation_mode/change_to_remote
-
-- Method: function call
-- Type: [autoware_adapi_v1_msgs/srv/ChangeOperationMode](../../../types/autoware_adapi_v1_msgs/srv/change_operation_mode.md)
-
-## Description
-
+---
+title: /api/operation_mode/change_to_remote
+method: function call
+type:
+  name: autoware_adapi_v1_msgs/srv/ChangeOperationMode
+  res:
+    - name: status
+      text: response status
+---
+
+{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
+{% block description %}
 Change the operation mode to remote. For details, see the [operation mode](./index.md).
-
-## Request
-
-None
-
-## Response
-
-| Name   | Type                                      | Description     |
-| ------ | ----------------------------------------- | --------------- |
-| status | autoware_adapi_v1_msgs/msg/ResponseStatus | response status |
+{% endblock %}
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/operation_mode/change_to_stop.md b/docs/design/autoware-interfaces/ad-api/list/api/operation_mode/change_to_stop.md
@@ -1,20 +1,14 @@
-<!-- This file is generated by a tool. Do not edit directly. -->
-
-# /api/operation_mode/change_to_stop
-
-- Method: function call
-- Type: [autoware_adapi_v1_msgs/srv/ChangeOperationMode](../../../types/autoware_adapi_v1_msgs/srv/change_operation_mode.md)
-
-## Description
-
+---
+title: /api/operation_mode/change_to_stop
+method: function call
+type:
+  name: autoware_adapi_v1_msgs/srv/ChangeOperationMode
+  res:
+    - name: status
+      text: response status
+---
+
+{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
+{% block description %}
 Change the operation mode to stop. For details, see the [operation mode](./index.md).
-
-## Request
-
-None
-
-## Response
-
-| Name   | Type                                      | Description     |
-| ------ | ----------------------------------------- | --------------- |
-| status | autoware_adapi_v1_msgs/msg/ResponseStatus | response status |
+{% endblock %}
diff --git a/.../autoware-interfaces/ad-api/list/api/operation_mode/disable_autoware_control.md b/.../autoware-interfaces/ad-api/list/api/operation_mode/disable_autoware_control.md
@@ -1,21 +1,15 @@
-<!-- This file is generated by a tool. Do not edit directly. -->
-
-# /api/operation_mode/disable_autoware_control
-
-- Method: function call
-- Type: [autoware_adapi_v1_msgs/srv/ChangeOperationMode](../../../types/autoware_adapi_v1_msgs/srv/change_operation_mode.md)
-
-## Description
-
+---
+title: /api/operation_mode/disable_autoware_control
+method: function call
+type:
+  name: autoware_adapi_v1_msgs/srv/ChangeOperationMode
+  res:
+    - name: status
+      text: response status
+---
+
+{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
+{% block description %}
 Disable vehicle control by Autoware. For details, see the [operation mode](./index.md).
 This API fails if the vehicle does not support mode change by software.
-
-## Request
-
-None
-
-## Response
-
-| Name   | Type                                      | Description     |
-| ------ | ----------------------------------------- | --------------- |
-| status | autoware_adapi_v1_msgs/msg/ResponseStatus | response status |
+{% endblock %}