Skip to content

Commit

Permalink
docs(common): adding .pages file (#7148)
Browse files Browse the repository at this point in the history
* docs(common): adding .pages file

Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]>

* fix naming

Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]>

* fix naming

Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]>

* fix naming

Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]>

* include main page plus explanation to autoware tools

Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]>

* style(pre-commit): autofix

---------

Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
zulfaqar-azmi-t4 and pre-commit-ci[bot] authored May 28, 2024
1 parent f3f853c commit c696905
Show file tree
Hide file tree
Showing 4 changed files with 80 additions and 1 deletion.
62 changes: 62 additions & 0 deletions common/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
nav:
- 'Introduction': common
- 'Testing Libraries':
- 'autoware_testing': common/autoware_testing/design/autoware_testing-design
- 'fake_test_node': common/fake_test_node/design/fake_test_node-design
- 'Common Libraries':
- 'autoware_auto_common':
- 'comparisons': common/autoware_auto_common/design/comparisons
- 'autoware_auto_geometry':
- 'interval': common/autoware_auto_geometry/design/interval
- 'polygon intersection 2d': common/autoware_auto_geometry/design/polygon_intersection_2d-design
- 'spatial hash': common/autoware_auto_geometry/design/spatial-hash-design
- 'autoware_auto_tf2': common/autoware_auto_tf2/design/autoware-auto-tf2-design
- 'autoware_point_types': common/autoware_point_types
- 'Cuda Utils': common/cuda_utils
- 'Geography Utils': common/geography_utils
- 'Global Parameter Loader': common/global_parameter_loader/Readme
- 'Glog Component': common/glog_component
- 'grid_map_utils': common/grid_map_utils
- 'interpolation': common/interpolation
- 'Kalman Filter': common/kalman_filter
- 'Motion Utils': common/motion_utils
- 'Vehicle Utils': common/motion_utils/docs/vehicle/vehicle
- 'Object Recognition Utils': common/object_recognition_utils
- 'OSQP Interface': common/osqp_interface/design/osqp_interface-design
- 'Perception Utils': common/perception_utils
- 'QP Interface': common/qp_interface/design/qp_interface-design
- 'Signal Processing':
- 'Introduction': common/signal_processing
- 'Butterworth Filter': common/signal_processing/documentation/ButterworthFilter
- 'TensorRT Common': common/tensorrt_common
- 'tier4_autoware_utils': common/tier4_autoware_utils
- 'traffic_light_utils': common/traffic_light_utils
- 'TVM Utility':
- 'Introduction': common/tvm_utility
- 'YOLOv2 Tiny Example': common/tvm_utility/tvm-utility-yolo-v2-tiny-tests
- 'RVIZ2 Plugins':
- 'autoware_auto_perception_rviz_plugin': common/autoware_auto_perception_rviz_plugin
- 'autoware_overlay_rviz_plugin': common/autoware_overlay_rviz_plugin/autoware_overlay_rviz_plugin
- 'autoware_mission_details_overlay_rviz_plugin': common/autoware_overlay_rviz_plugin/autoware_mission_details_overlay_rviz_plugin
- 'bag_time_manager_rviz_plugin': common/bag_time_manager_rviz_plugin
- 'polar_grid': common/polar_grid/Readme
- 'tier4_adapi_rviz_plugin': common/tier4_adapi_rviz_plugin
- 'tier4_api_utils': common/tier4_api_utils
- 'tier4_camera_view_rviz_plugin': common/tier4_camera_view_rviz_plugin
- 'tier4_datetime_rviz_plugin': common/tier4_datetime_rviz_plugin
- 'tier4_localization_rviz_plugin': common/tier4_localization_rviz_plugin
- 'tier4_perception_rviz_plugin': common/tier4_perception_rviz_plugin
- 'tier4_planning_rviz_plugin': common/tier4_planning_rviz_plugin
- 'tier4_state_rviz_plugin': common/tier4_state_rviz_plugin
- 'tier4_system_rviz_plugin': common/tier4_system_rviz_plugin
- 'tier4_traffic_light_rviz_plugin': common/tier4_traffic_light_rviz_plugin
- 'tier4_vehicle_rviz_plugin': common/tier4_vehicle_rviz_plugin
- 'traffic_light_recognition_marker_publisher': common/traffic_light_recognition_marker_publisher/Readme
- 'Node':
- 'Goal Distance Calculator': common/goal_distance_calculator/Readme
- 'Path Distance Calculator': common/path_distance_calculator/Readme
- 'Others':
- 'autoware_ad_api_specs': common/autoware_ad_api_specs
- 'component_interface_specs': common/component_interface_specs
- 'component_interface_tools': common/component_interface_tools
- 'component_interface_utils': common/component_interface_utils
16 changes: 16 additions & 0 deletions common/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Common

## Getting Started

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.

!!! note

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/).

## Highlights

Some of the commonly used libraries are:

1. `tier4_autoware_utils`
2. `motion_utils`
1 change: 1 addition & 0 deletions common/autoware_point_types/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Autoware Point Types
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# path_distance_calculator
# Traffic Light Recognition Marker Publisher

## Purpose

Expand Down

0 comments on commit c696905

Please sign in to comment.