Skip to content

Commit adbb924

Browse files
zulfaqar-azmi-t4pre-commit-ci[bot]
authored andcommitted
docs(common): adding .pages file (autowarefoundation#7148)
* docs(common): adding .pages file Signed-off-by: Muhammad Zulfaqar Azmi <zulfaqar.azmi@tier4.jp> * fix naming Signed-off-by: Muhammad Zulfaqar Azmi <zulfaqar.azmi@tier4.jp> * fix naming Signed-off-by: Muhammad Zulfaqar Azmi <zulfaqar.azmi@tier4.jp> * fix naming Signed-off-by: Muhammad Zulfaqar Azmi <zulfaqar.azmi@tier4.jp> * include main page plus explanation to autoware tools Signed-off-by: Muhammad Zulfaqar Azmi <zulfaqar.azmi@tier4.jp> * style(pre-commit): autofix --------- Signed-off-by: Muhammad Zulfaqar Azmi <zulfaqar.azmi@tier4.jp> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 512693b commit adbb924

File tree

4 files changed

+80
-1
lines changed

4 files changed

+80
-1
lines changed

common/.pages

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
nav:
2+
- 'Introduction': common
3+
- 'Testing Libraries':
4+
- 'autoware_testing': common/autoware_testing/design/autoware_testing-design
5+
- 'fake_test_node': common/fake_test_node/design/fake_test_node-design
6+
- 'Common Libraries':
7+
- 'autoware_auto_common':
8+
- 'comparisons': common/autoware_auto_common/design/comparisons
9+
- 'autoware_auto_geometry':
10+
- 'interval': common/autoware_auto_geometry/design/interval
11+
- 'polygon intersection 2d': common/autoware_auto_geometry/design/polygon_intersection_2d-design
12+
- 'spatial hash': common/autoware_auto_geometry/design/spatial-hash-design
13+
- 'autoware_auto_tf2': common/autoware_auto_tf2/design/autoware-auto-tf2-design
14+
- 'autoware_point_types': common/autoware_point_types
15+
- 'Cuda Utils': common/cuda_utils
16+
- 'Geography Utils': common/geography_utils
17+
- 'Global Parameter Loader': common/global_parameter_loader/Readme
18+
- 'Glog Component': common/glog_component
19+
- 'grid_map_utils': common/grid_map_utils
20+
- 'interpolation': common/interpolation
21+
- 'Kalman Filter': common/kalman_filter
22+
- 'Motion Utils': common/motion_utils
23+
- 'Vehicle Utils': common/motion_utils/docs/vehicle/vehicle
24+
- 'Object Recognition Utils': common/object_recognition_utils
25+
- 'OSQP Interface': common/osqp_interface/design/osqp_interface-design
26+
- 'Perception Utils': common/perception_utils
27+
- 'QP Interface': common/qp_interface/design/qp_interface-design
28+
- 'Signal Processing':
29+
- 'Introduction': common/signal_processing
30+
- 'Butterworth Filter': common/signal_processing/documentation/ButterworthFilter
31+
- 'TensorRT Common': common/tensorrt_common
32+
- 'tier4_autoware_utils': common/tier4_autoware_utils
33+
- 'traffic_light_utils': common/traffic_light_utils
34+
- 'TVM Utility':
35+
- 'Introduction': common/tvm_utility
36+
- 'YOLOv2 Tiny Example': common/tvm_utility/tvm-utility-yolo-v2-tiny-tests
37+
- 'RVIZ2 Plugins':
38+
- 'autoware_auto_perception_rviz_plugin': common/autoware_auto_perception_rviz_plugin
39+
- 'autoware_overlay_rviz_plugin': common/autoware_overlay_rviz_plugin/autoware_overlay_rviz_plugin
40+
- 'autoware_mission_details_overlay_rviz_plugin': common/autoware_overlay_rviz_plugin/autoware_mission_details_overlay_rviz_plugin
41+
- 'bag_time_manager_rviz_plugin': common/bag_time_manager_rviz_plugin
42+
- 'polar_grid': common/polar_grid/Readme
43+
- 'tier4_adapi_rviz_plugin': common/tier4_adapi_rviz_plugin
44+
- 'tier4_api_utils': common/tier4_api_utils
45+
- 'tier4_camera_view_rviz_plugin': common/tier4_camera_view_rviz_plugin
46+
- 'tier4_datetime_rviz_plugin': common/tier4_datetime_rviz_plugin
47+
- 'tier4_localization_rviz_plugin': common/tier4_localization_rviz_plugin
48+
- 'tier4_perception_rviz_plugin': common/tier4_perception_rviz_plugin
49+
- 'tier4_planning_rviz_plugin': common/tier4_planning_rviz_plugin
50+
- 'tier4_state_rviz_plugin': common/tier4_state_rviz_plugin
51+
- 'tier4_system_rviz_plugin': common/tier4_system_rviz_plugin
52+
- 'tier4_traffic_light_rviz_plugin': common/tier4_traffic_light_rviz_plugin
53+
- 'tier4_vehicle_rviz_plugin': common/tier4_vehicle_rviz_plugin
54+
- 'traffic_light_recognition_marker_publisher': common/traffic_light_recognition_marker_publisher/Readme
55+
- 'Node':
56+
- 'Goal Distance Calculator': common/goal_distance_calculator/Readme
57+
- 'Path Distance Calculator': common/path_distance_calculator/Readme
58+
- 'Others':
59+
- 'autoware_ad_api_specs': common/autoware_ad_api_specs
60+
- 'component_interface_specs': common/component_interface_specs
61+
- 'component_interface_tools': common/component_interface_tools
62+
- 'component_interface_utils': common/component_interface_utils

common/README.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Common
2+
3+
## Getting Started
4+
5+
The Autoware.Universe Common folder consists of common and testing libraries that are used by other Autoware components, as well as useful plugins for visualization in RVIZ2.
6+
7+
!!! note
8+
9+
In addition to the ones listed in this folder, users can also have a look at some of the add-ons in the `autoware_tools/common` documentation [page](https://autowarefoundation.github.io/autoware_tools/main/common/mission_planner_rviz_plugin/).
10+
11+
## Highlights
12+
13+
Some of the commonly used libraries are:
14+
15+
1. `tier4_autoware_utils`
16+
2. `motion_utils`

common/autoware_point_types/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Autoware Point Types

common/traffic_light_recognition_marker_publisher/Readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# path_distance_calculator
1+
# Traffic Light Recognition Marker Publisher
22

33
## Purpose
44

0 commit comments

Comments
 (0)