Skip to content

Commit bb9cbd3

Browse files
isamu-takagixmfcx
isamu-takagi
and
xmfcx
authored
refactor(autoware-interfaces): use jinja2 template for pages of Autoware interfaces (#372)
* feat: add templates and macros Signed-off-by: Takagi, Isamu <[email protected]> * feat: update route api pages Signed-off-by: Takagi, Isamu <[email protected]> * feat: update template Signed-off-by: Takagi, Isamu <[email protected]> * feat: update localization api pages Signed-off-by: Takagi, Isamu <[email protected]> * feat: update api pages Signed-off-by: Takagi, Isamu <[email protected]> * feat: resolve field types Signed-off-by: Takagi, Isamu <[email protected]> * feat: add message link Signed-off-by: Takagi, Isamu <[email protected]> * feat: change yaml format Signed-off-by: Takagi, Isamu <[email protected]> * feat: generate type pages Signed-off-by: Takagi, Isamu <[email protected]> * feat: type page template Signed-off-by: Takagi, Isamu <[email protected]> * feat: update type pages Signed-off-by: Takagi, Isamu <[email protected]> * feat: update comment Signed-off-by: Takagi, Isamu <[email protected]> * docs: add readme Signed-off-by: Takagi, Isamu <[email protected]> * Update tools/autoware-interfaces/README.md Co-authored-by: M. Fatih Cırıt <[email protected]> * feat: fix spell check Signed-off-by: Takagi, Isamu <[email protected]> * feat: fix tool comment Signed-off-by: Takagi, Isamu <[email protected]> --------- Signed-off-by: Takagi, Isamu <[email protected]> Co-authored-by: M. Fatih Cırıt <[email protected]>
1 parent 1446caf commit bb9cbd3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+1056
-786
lines changed

‎docs/design/autoware-interfaces/ad-api/list/api/fail_safe/mrm_state.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
1-
<!-- This file is generated by a tool. Do not edit directly. -->
2-
3-
# /api/fail_safe/mrm_state
4-
5-
- Method: notification
6-
- Type: [autoware_adapi_v1_msgs/msg/MrmState](../../../types/autoware_adapi_v1_msgs/msg/mrm_state.md)
7-
8-
## Description
1+
---
2+
title: /api/fail_safe/mrm_state
3+
method: notification
4+
type:
5+
name: autoware_adapi_v1_msgs/msg/MrmState
6+
msg:
7+
- name: state
8+
text: The state of MRM operation.
9+
- name: behavior
10+
text: The currently selected behavior of MRM.
11+
---
912

13+
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
14+
{% block description %}
1015
Get the MRM state. For details, see the [fail-safe](./index.md).
11-
12-
## Message
13-
14-
| Name | Type | Description |
15-
| -------- | ------ | --------------------------------------- |
16-
| state | uint16 | The state of MRM operation. |
17-
| behavior | uint16 | The currently selected behavior of MRM. |
16+
{% endblock %}

‎docs/design/autoware-interfaces/ad-api/list/api/interface/version.md

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,18 @@
1-
<!-- This file is generated by a tool. Do not edit directly. -->
2-
3-
# /api/interface/version
4-
5-
- Method: function call
6-
- Type: [autoware_adapi_version_msgs/srv/InterfaceVersion](../../../types/autoware_adapi_version_msgs/srv/interface_version.md)
7-
8-
## Description
9-
1+
---
2+
title: /api/interface/version
3+
method: function call
4+
type:
5+
name: autoware_adapi_version_msgs/srv/InterfaceVersion
6+
res:
7+
- name: major
8+
text: major version
9+
- name: minor
10+
text: minor version
11+
- name: patch
12+
text: patch version
13+
---
14+
15+
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
16+
{% block description %}
1017
Get the interface version. The version follows Semantic Versioning.
11-
12-
## Request
13-
14-
None
15-
16-
## Response
17-
18-
| Name | Type | Description |
19-
| ----- | ------ | ------------- |
20-
| major | uint16 | major version |
21-
| minor | uint16 | minor version |
22-
| patch | uint16 | patch version |
18+
{% endblock %}

‎docs/design/autoware-interfaces/ad-api/list/api/localization/initialization_state.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
1-
<!-- This file is generated by a tool. Do not edit directly. -->
2-
3-
# /api/localization/initialization_state
4-
5-
- Method: notification
6-
- Type: [autoware_adapi_v1_msgs/msg/LocalizationInitializationState](../../../types/autoware_adapi_v1_msgs/msg/localization_initialization_state.md)
7-
8-
## Description
9-
1+
---
2+
title: /api/localization/initialization_state
3+
method: notification
4+
type:
5+
name: autoware_adapi_v1_msgs/msg/LocalizationInitializationState
6+
msg:
7+
- name: state
8+
text: A value of the [localization initialization state](./index.md).
9+
---
10+
11+
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
12+
{% block description %}
1013
Get the initialization state of localization. For details, see the [localization initialization state](./index.md).
11-
12-
## Message
13-
14-
| Name | Type | Description |
15-
| ----- | ------ | --------------------------------------------------------------- |
16-
| state | uint16 | A value of the [localization initialization state](./index.md). |
14+
{% endblock %}

‎docs/design/autoware-interfaces/ad-api/list/api/localization/initialize.md

Lines changed: 16 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,17 @@
1-
<!-- This file is generated by a tool. Do not edit directly. -->
2-
3-
# /api/localization/initialize
4-
5-
- Method: function call
6-
- Type: [autoware_adapi_v1_msgs/srv/InitializeLocalization](../../../types/autoware_adapi_v1_msgs/srv/initialize_localization.md)
7-
8-
## Description
9-
1+
---
2+
title: /api/localization/initialize
3+
method: function call
4+
type:
5+
name: autoware_adapi_v1_msgs/srv/InitializeLocalization
6+
req:
7+
- name: pose
8+
text: A global pose as the initial guess. If omitted, the GNSS pose will be used.
9+
res:
10+
- name: status
11+
text: response status
12+
---
13+
14+
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
15+
{% block description %}
1016
Request to initialize localization. For details, see the [pose state](./index.md).
11-
12-
## Request
13-
14-
| Name | Type | Description |
15-
| ---- | ------------------------------------------------ | --------------------------------------------------------------------------- |
16-
| pose | geometry_msgs/msg/PoseWithCovarianceStamped[<=1] | A global pose as the initial guess. If omitted, the GNSS pose will be used. |
17-
18-
## Response
19-
20-
| Name | Type | Description |
21-
| ------ | ----------------------------------------- | --------------- |
22-
| status | autoware_adapi_v1_msgs/msg/ResponseStatus | response status |
17+
{% endblock %}

‎docs/design/autoware-interfaces/ad-api/list/api/motion/accept_start.md

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,14 @@
1-
<!-- This file is generated by a tool. Do not edit directly. -->
2-
3-
# /api/motion/accept_start
4-
5-
- Method: function call
6-
- Type: [autoware_adapi_v1_msgs/srv/AcceptStart](../../../types/autoware_adapi_v1_msgs/srv/accept_start.md)
7-
8-
## Description
9-
1+
---
2+
title: /api/motion/accept_start
3+
method: function call
4+
type:
5+
name: autoware_adapi_v1_msgs/srv/AcceptStart
6+
res:
7+
- name: status
8+
text: response status
9+
---
10+
11+
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
12+
{% block description %}
1013
Accept the vehicle to start. This API can be used when the [motion state](./index.md) is STARTING.
11-
12-
## Request
13-
14-
None
15-
16-
## Response
17-
18-
| Name | Type | Description |
19-
| ------ | ----------------------------------------- | --------------- |
20-
| status | autoware_adapi_v1_msgs/msg/ResponseStatus | response status |
14+
{% endblock %}

‎docs/design/autoware-interfaces/ad-api/list/api/motion/state.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
1-
<!-- This file is generated by a tool. Do not edit directly. -->
2-
3-
# /api/motion/state
4-
5-
- Method: notification
6-
- Type: [autoware_adapi_v1_msgs/msg/MotionState](../../../types/autoware_adapi_v1_msgs/msg/motion_state.md)
7-
8-
## Description
9-
1+
---
2+
title: /api/motion/state
3+
method: notification
4+
type:
5+
name: autoware_adapi_v1_msgs/msg/MotionState
6+
msg:
7+
- name: state
8+
text: A value of the motion state.
9+
---
10+
11+
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
12+
{% block description %}
1013
Get the motion state. For details, see the [motion state](./index.md).
11-
12-
## Message
13-
14-
| Name | Type | Description |
15-
| ----- | ------ | ---------------------------- |
16-
| state | uint16 | A value of the motion state. |
14+
{% endblock %}

‎docs/design/autoware-interfaces/ad-api/list/api/operation_mode/change_to_autonomous.md

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,14 @@
1-
<!-- This file is generated by a tool. Do not edit directly. -->
2-
3-
# /api/operation_mode/change_to_autonomous
4-
5-
- Method: function call
6-
- Type: [autoware_adapi_v1_msgs/srv/ChangeOperationMode](../../../types/autoware_adapi_v1_msgs/srv/change_operation_mode.md)
7-
8-
## Description
9-
1+
---
2+
title: /api/operation_mode/change_to_autonomous
3+
method: function call
4+
type:
5+
name: autoware_adapi_v1_msgs/srv/ChangeOperationMode
6+
res:
7+
- name: status
8+
text: response status
9+
---
10+
11+
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
12+
{% block description %}
1013
Change the operation mode to autonomous. For details, see the [operation mode](./index.md).
11-
12-
## Request
13-
14-
None
15-
16-
## Response
17-
18-
| Name | Type | Description |
19-
| ------ | ----------------------------------------- | --------------- |
20-
| status | autoware_adapi_v1_msgs/msg/ResponseStatus | response status |
14+
{% endblock %}

‎docs/design/autoware-interfaces/ad-api/list/api/operation_mode/change_to_local.md

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,14 @@
1-
<!-- This file is generated by a tool. Do not edit directly. -->
2-
3-
# /api/operation_mode/change_to_local
4-
5-
- Method: function call
6-
- Type: [autoware_adapi_v1_msgs/srv/ChangeOperationMode](../../../types/autoware_adapi_v1_msgs/srv/change_operation_mode.md)
7-
8-
## Description
9-
1+
---
2+
title: /api/operation_mode/change_to_local
3+
method: function call
4+
type:
5+
name: autoware_adapi_v1_msgs/srv/ChangeOperationMode
6+
res:
7+
- name: status
8+
text: response status
9+
---
10+
11+
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
12+
{% block description %}
1013
Change the operation mode to local. For details, see the [operation mode](./index.md).
11-
12-
## Request
13-
14-
None
15-
16-
## Response
17-
18-
| Name | Type | Description |
19-
| ------ | ----------------------------------------- | --------------- |
20-
| status | autoware_adapi_v1_msgs/msg/ResponseStatus | response status |
14+
{% endblock %}

‎docs/design/autoware-interfaces/ad-api/list/api/operation_mode/change_to_remote.md

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,14 @@
1-
<!-- This file is generated by a tool. Do not edit directly. -->
2-
3-
# /api/operation_mode/change_to_remote
4-
5-
- Method: function call
6-
- Type: [autoware_adapi_v1_msgs/srv/ChangeOperationMode](../../../types/autoware_adapi_v1_msgs/srv/change_operation_mode.md)
7-
8-
## Description
9-
1+
---
2+
title: /api/operation_mode/change_to_remote
3+
method: function call
4+
type:
5+
name: autoware_adapi_v1_msgs/srv/ChangeOperationMode
6+
res:
7+
- name: status
8+
text: response status
9+
---
10+
11+
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
12+
{% block description %}
1013
Change the operation mode to remote. For details, see the [operation mode](./index.md).
11-
12-
## Request
13-
14-
None
15-
16-
## Response
17-
18-
| Name | Type | Description |
19-
| ------ | ----------------------------------------- | --------------- |
20-
| status | autoware_adapi_v1_msgs/msg/ResponseStatus | response status |
14+
{% endblock %}

‎docs/design/autoware-interfaces/ad-api/list/api/operation_mode/change_to_stop.md

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,14 @@
1-
<!-- This file is generated by a tool. Do not edit directly. -->
2-
3-
# /api/operation_mode/change_to_stop
4-
5-
- Method: function call
6-
- Type: [autoware_adapi_v1_msgs/srv/ChangeOperationMode](../../../types/autoware_adapi_v1_msgs/srv/change_operation_mode.md)
7-
8-
## Description
9-
1+
---
2+
title: /api/operation_mode/change_to_stop
3+
method: function call
4+
type:
5+
name: autoware_adapi_v1_msgs/srv/ChangeOperationMode
6+
res:
7+
- name: status
8+
text: response status
9+
---
10+
11+
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
12+
{% block description %}
1013
Change the operation mode to stop. For details, see the [operation mode](./index.md).
11-
12-
## Request
13-
14-
None
15-
16-
## Response
17-
18-
| Name | Type | Description |
19-
| ------ | ----------------------------------------- | --------------- |
20-
| status | autoware_adapi_v1_msgs/msg/ResponseStatus | response status |
14+
{% endblock %}

0 commit comments

Comments
 (0)