From 9cf4183309f69a6e3ddf93dfd9d28d0f5efaa9df Mon Sep 17 00:00:00 2001 From: "Takagi, Isamu" <43976882+isamu-takagi@users.noreply.github.com> Date: Tue, 23 Apr 2024 21:40:10 +0900 Subject: [PATCH] fix: warning for relative links (#538) fix: fix relative links Signed-off-by: Takagi, Isamu --- .../ros-nodes/coordinate-system.md | 2 +- docs/contributing/index.md | 8 ++++---- .../difference-from-ai-and-auto.md | 2 +- .../components/vehicle-interface.md | 2 +- .../templates/autoware-data-type.jinja2 | 4 ++-- .../templates/autoware-interface.jinja2 | 2 +- .../creating-vector-map/index.md | 12 +++++------ .../creating-vector-map/lanelet2/index.md | 2 +- .../open-source-slam/lio-sam/index.md | 2 +- .../calibration-tools/index.md | 12 +++++------ .../ground-lidar-calibration/index.md | 2 +- .../calibrating-sensors/index.md | 2 +- .../lidar-camera-calibration/index.md | 4 ++-- .../lidar-lidar-calibration/index.md | 4 ++-- .../creating-sensor-model/index.md | 2 +- .../creating-vehicle-model/index.md | 2 +- .../index.md | 4 ++-- .../creating-vehicle-interface.md | 2 +- .../launch-autoware/index.md | 20 +++++++++---------- .../launch-autoware/localization/index.md | 4 ++-- .../integrating-autoware/overview.md | 4 ++-- .../defining-temporal-performance-metrics.md | 6 +++--- docs/index.md | 18 ++++++++--------- docs/installation/index.md | 6 +++--- .../planning-simulation/installation.md | 2 +- main.py | 4 ++-- 26 files changed, 67 insertions(+), 67 deletions(-) diff --git a/docs/contributing/coding-guidelines/ros-nodes/coordinate-system.md b/docs/contributing/coding-guidelines/ros-nodes/coordinate-system.md index 6e6bb4a61ee..4a8a4b3296d 100644 --- a/docs/contributing/coding-guidelines/ros-nodes/coordinate-system.md +++ b/docs/contributing/coding-guidelines/ros-nodes/coordinate-system.md @@ -119,7 +119,7 @@ References: The conversion relationship between every sensor coordinate system and `base_link` can be obtained through sensor calibration technology. Please consult the following link - [calibrating your sensors](../../../how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors) for instructions + [calibrating your sensors](../../../how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors/index.md) for instructions on how to calibrate your sensors. 2. Localization diff --git a/docs/contributing/index.md b/docs/contributing/index.md index dbc72cceb16..03914acbc38 100644 --- a/docs/contributing/index.md +++ b/docs/contributing/index.md @@ -29,14 +29,14 @@ If you believe that someone in the community has violated the Code of Conduct, p To gain a high-level understanding of Autoware's architecture and design, the following pages provide a brief overview: -- [Autoware architecture](../design/) -- [Autoware concepts](../design/autoware-concepts/) +- [Autoware architecture](../design/index.md) +- [Autoware concepts](../design/autoware-concepts/index.md) -For experienced developers, the [Autoware interfaces](../design/autoware-interfaces/) and [individual component pages](../design/autoware-interfaces/components/) should also be reviewed to understand the inputs and outputs for each component or module at a more detailed level. +For experienced developers, the [Autoware interfaces](../design/autoware-interfaces/index.md) and [individual component pages](../design/autoware-interfaces/components/index.md) should also be reviewed to understand the inputs and outputs for each component or module at a more detailed level. ### Contributing to open source projects -If you are new to open source projects, we recommend reading GitHub's [How to Contribute to Open Source guide](https://opensource.guide/how-to-contribute/) for an overview of why people contribute to open source projects, what it means to contribute and much more besides. +If you are new to open source projects, we recommend reading GitHub's [How to Contribute to Open Source guide](https://opensource.guide/how-to-contribute) for an overview of why people contribute to open source projects, what it means to contribute and much more besides. ## How can I get help? diff --git a/docs/design/autoware-concepts/difference-from-ai-and-auto.md b/docs/design/autoware-concepts/difference-from-ai-and-auto.md index fa372e1536e..3a572dc166b 100644 --- a/docs/design/autoware-concepts/difference-from-ai-and-auto.md +++ b/docs/design/autoware-concepts/difference-from-ai-and-auto.md @@ -42,4 +42,4 @@ Autoware Core carries over the original policy of Autoware.Auto to be a stable a - Code quality requirements for Universe are more relaxed to make it easier for new developers, students and researchers to contribute, but will still be stricter than the requirements for Autoware.AI. - Any advanced features added to Universe that are useful to the wider Autoware community will be reviewed and considered for potential inclusion in the main Autoware Core codebase. -This way, the primary requirement of having a stable and safe autonomous driving system can be achieved, whilst simultaneously enabling access to state-of-the-art features created by third-party contributors. For more details about the design of Autoware Core/Universe, refer to the [Autoware concepts documentation page](../autoware-concepts/). +This way, the primary requirement of having a stable and safe autonomous driving system can be achieved, whilst simultaneously enabling access to state-of-the-art features created by third-party contributors. For more details about the design of Autoware Core/Universe, refer to the [Autoware concepts documentation page](../autoware-concepts/index.md). diff --git a/docs/design/autoware-interfaces/components/vehicle-interface.md b/docs/design/autoware-interfaces/components/vehicle-interface.md index 4074f3a0897..d503d093f1b 100644 --- a/docs/design/autoware-interfaces/components/vehicle-interface.md +++ b/docs/design/autoware-interfaces/components/vehicle-interface.md @@ -1,6 +1,6 @@ # Vehicle Interface -This page describes the Vehicle Interface Component. Please refer to the [Vehicle Interface design document](../../autoware-architecture/vehicle/) for high-level concepts and data flow. +This page describes the Vehicle Interface Component. Please refer to the [Vehicle Interface design document](../../autoware-architecture/vehicle/index.md) for high-level concepts and data flow. ![Vehicle interface diagram](images/vehicle-interface.drawio.svg) diff --git a/docs/design/autoware-interfaces/templates/autoware-data-type.jinja2 b/docs/design/autoware-interfaces/templates/autoware-data-type.jinja2 index 3acf494d8e1..1792c82255d 100644 --- a/docs/design/autoware-interfaces/templates/autoware-data-type.jinja2 +++ b/docs/design/autoware-interfaces/templates/autoware-data-type.jinja2 @@ -9,7 +9,7 @@ {%- if uses %} {%- for name in uses %} -- {{ create_relative_link(name, 'design/autoware-interfaces/ad-api/types/' + name) }} +- {{ create_relative_link(name, 'design/autoware-interfaces/ad-api/types/' + name + '.md') }} {%- endfor %} {%- else %} - None @@ -19,7 +19,7 @@ {%- if used %} {%- for name in used %} -- {{ create_relative_link(name, 'design/autoware-interfaces/ad-api/types/' + name) }} +- {{ create_relative_link(name, 'design/autoware-interfaces/ad-api/types/' + name + '.md') }} {%- endfor %} {%- else %} - None diff --git a/docs/design/autoware-interfaces/templates/autoware-interface.jinja2 b/docs/design/autoware-interfaces/templates/autoware-interface.jinja2 index f57daa463d5..fb0e381c9e9 100644 --- a/docs/design/autoware-interfaces/templates/autoware-interface.jinja2 +++ b/docs/design/autoware-interfaces/templates/autoware-interface.jinja2 @@ -4,7 +4,7 @@ - Latest Version: {{ status }} - Method: {{ method }} -- Data Type: {{ create_relative_link(type.name, 'design/autoware-interfaces/ad-api/types/' + type.name) }} +- Data Type: {{ create_relative_link(type.name, 'design/autoware-interfaces/ad-api/types/' + type.name + '.md') }} ## Description diff --git a/docs/how-to-guides/integrating-autoware/creating-maps/creating-vector-map/index.md b/docs/how-to-guides/integrating-autoware/creating-maps/creating-vector-map/index.md index d233b33b00d..01df4f45b76 100644 --- a/docs/how-to-guides/integrating-autoware/creating-maps/creating-vector-map/index.md +++ b/docs/how-to-guides/integrating-autoware/creating-maps/creating-vector-map/index.md @@ -21,9 +21,9 @@ please check the [official guide](https://docs.web.auto/en/user-manuals/vector-m You can follow these pages for creating a Lanelet2 map and understanding its regulatory elements. -- [Lanelet2](./lanelet2) -- [Crosswalk](./crosswalk) -- [Stop Line](./stop-line) -- [Traffic Light](./traffic-light) -- [Speed Bump](./speed-bump) -- [Detection Area](./detection-area) +- [Lanelet2](./lanelet2/index.md) +- [Crosswalk](./crosswalk/index.md) +- [Stop Line](./stop-line/index.md) +- [Traffic Light](./traffic-light/index.md) +- [Speed Bump](./speed-bump/index.md) +- [Detection Area](./detection-area/index.md) diff --git a/docs/how-to-guides/integrating-autoware/creating-maps/creating-vector-map/lanelet2/index.md b/docs/how-to-guides/integrating-autoware/creating-maps/creating-vector-map/lanelet2/index.md index 2a5c81cf5fd..2791f812bb1 100644 --- a/docs/how-to-guides/integrating-autoware/creating-maps/creating-vector-map/lanelet2/index.md +++ b/docs/how-to-guides/integrating-autoware/creating-maps/creating-vector-map/lanelet2/index.md @@ -3,7 +3,7 @@ At this page, we will explain how to create a simple lanelet on your point cloud map. If you didn't have a point cloud map before, please check -and follow the steps on the [LIO-SAM mapping page](../../open-source-slam/lio-sam) +and follow the steps on the [LIO-SAM mapping page](../../open-source-slam/lio-sam/index.md) for how to create a point cloud map for Autoware. ## Creating a Lanelet2 diff --git a/docs/how-to-guides/integrating-autoware/creating-maps/open-source-slam/lio-sam/index.md b/docs/how-to-guides/integrating-autoware/creating-maps/open-source-slam/lio-sam/index.md index 40205476987..3cdf8477f8e 100644 --- a/docs/how-to-guides/integrating-autoware/creating-maps/open-source-slam/lio-sam/index.md +++ b/docs/how-to-guides/integrating-autoware/creating-maps/open-source-slam/lio-sam/index.md @@ -241,7 +241,7 @@ Here is the video for demonstration of LIO-SAM mapping in our campus environment The output map format is local UTM, we will change local UTM map to MGRS format for tutorial_vehicle. Also, if you want change UTM to MGRS for autoware, -please follow [convert-utm-to-mgrs-map](../../converting-utm-to-mgrs-map) page. +please follow [convert-utm-to-mgrs-map](../../converting-utm-to-mgrs-map/index.md) page. ## Example Result diff --git a/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors/calibration-tools/index.md b/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors/calibration-tools/index.md index 572210fbea8..d718743385f 100644 --- a/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors/calibration-tools/index.md +++ b/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors/calibration-tools/index.md @@ -77,9 +77,9 @@ we will modify `extrinsic_calibration_package` for our sensor kit. For tutorial_vehicle, completed launch files when created following tutorial sections can be found [here](https://github.com/leo-drive/calibration_tools_tutorial_vehicle/tree/tutorial_vehicle/sensor/extrinsic_calibration_manager/launch/tutorial_vehicle_sensor_kit). -- [Manual Calibration](../extrinsic-manual-calibration) -- [Lidar-Lidar Calibration](../lidar-lidar-calibration) - - [Ground Plane-Lidar Calibration](../ground-lidar-calibration) -- [Intrinsic Camera Calibration](../intrinsic-camera-calibration) -- [Lidar-Camera Calibration](../lidar-camera-calibration) -- [Lidar-Imu Calibration](../lidar-imu-calibration) +- [Manual Calibration](../extrinsic-manual-calibration/index.md) +- [Lidar-Lidar Calibration](../lidar-lidar-calibration/index.md) + - [Ground Plane-Lidar Calibration](../ground-lidar-calibration/index.md) +- [Intrinsic Camera Calibration](../intrinsic-camera-calibration/index.md) +- [Lidar-Camera Calibration](../lidar-camera-calibration/index.md) +- [Lidar-Imu Calibration](../lidar-imu-calibration/index.md) diff --git a/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors/ground-lidar-calibration/index.md b/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors/ground-lidar-calibration/index.md index f89a317dfa2..0d552cfb37f 100644 --- a/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors/ground-lidar-calibration/index.md +++ b/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors/ground-lidar-calibration/index.md @@ -10,7 +10,7 @@ in a way that aligns the points corresponding to the ground within the point cloud with the XY plane of the base_link. This means that only the z, roll, and pitch values of the tf undergo calibration, while the remaining x, y, and yaw values must be calibrated using other methods, -such as [manual adjustment](../extrinsic-manual-calibration) or [mapping-based lidar-lidar calibration](../lidar-camera-calibration). +such as [manual adjustment](../extrinsic-manual-calibration/index.md) or [mapping-based lidar-lidar calibration](../lidar-camera-calibration/index.md). You need to apply this calibration method to each lidar separately, so our bag should contain all lidars to be calibrated. diff --git a/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors/index.md b/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors/index.md index a1917de804f..ad2aff94b29 100644 --- a/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors/index.md +++ b/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors/index.md @@ -11,7 +11,7 @@ or as tf launch files. In this documentation, we will explain TIER IV's [CalibrationTools](https://github.com/tier4/CalibrationTools) repository for the calibration process. Please look -at [Starting with TIER IV's CalibrationTools page](./calibration-tools) for installation and usage of this tool. +at [Starting with TIER IV's CalibrationTools page](./calibration-tools/index.md) for installation and usage of this tool. If you want to look at other calibration packages and methods, you can check out the following packages. diff --git a/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors/lidar-camera-calibration/index.md b/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors/lidar-camera-calibration/index.md index 9b78aaad1c9..8cd1217e231 100644 --- a/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors/lidar-camera-calibration/index.md +++ b/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors/lidar-camera-calibration/index.md @@ -15,8 +15,8 @@ another [Lidar-Camera calibration method](https://github.com/tier4/CalibrationTo !!! warning - You need to apply [intrinsic calibration](../intrinsic-camera-calibration) before starting lidar-camera extrinsic calibration process. Also, - please obtain the initial calibration results from the [Manual Calibration](../extrinsic-manual-calibration) section. + You need to apply [intrinsic calibration](../intrinsic-camera-calibration/index.md) before starting lidar-camera extrinsic calibration process. Also, + please obtain the initial calibration results from the [Manual Calibration](../extrinsic-manual-calibration/index.md) section. This is crucial for obtaining accurate results from this tool. We will utilize the initial calibration parameters that were calculated in the previous step of this tutorial. diff --git a/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors/lidar-lidar-calibration/index.md b/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors/lidar-lidar-calibration/index.md index fb07772f6ca..44ddb08c1ea 100644 --- a/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors/lidar-lidar-calibration/index.md +++ b/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors/lidar-lidar-calibration/index.md @@ -8,7 +8,7 @@ CalibrationTools. !!! warning - Please obtain the initial calibration results from the [Manual Calibration](../extrinsic-manual-calibration) section. + Please obtain the initial calibration results from the [Manual Calibration](../extrinsic-manual-calibration/index.md) section. This is crucial for obtaining accurate results from this tool. We will utilize the initial calibration parameters that were calculated in the previous step of this tutorial. @@ -383,7 +383,7 @@ After the calibration is completed, then you should rviz2 screen like the image ![mapping-based-calibration-result](images/mapping-based-calibration-result.png) -The red points indicate pointcloud that initial calibration results of [previous section](../extrinsic-manual-calibration). +The red points indicate pointcloud that initial calibration results of [previous section](../extrinsic-manual-calibration/index.md). The green points indicate aligned point (calibration result). The calibration results will be saved automatically on your `dst_yaml` ($HOME/sensor_kit_calibration.yaml) at this tutorial. diff --git a/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/creating-sensor-model/index.md b/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/creating-sensor-model/index.md index 740b359a8cd..65f86ea5371 100644 --- a/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/creating-sensor-model/index.md +++ b/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/creating-sensor-model/index.md @@ -107,7 +107,7 @@ Now, we will modify these files according to our sensor design. This file defines the mounting positions and orientations of sensors with `sensor_kit_base_link` as the parent frame. We can assume `sensor_kit_base_link` frame is bottom of your main Lidar sensor. We must create this file with euler format as [x, y, z, roll, pitch, yaw]. -Also, we will set these values with "0" until the [calibration steps](../calibrating-sensors). +Also, we will set these values with "0" until the [calibration steps](../calibrating-sensors/index.md). We will define new frames for this file, and we will connect them `.xacro` files. We recommend naming as if your lidar sensor frame as "velodyne_top", diff --git a/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/creating-vehicle-model/index.md b/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/creating-vehicle-model/index.md index fdb61704846..9c07f8ac15a 100644 --- a/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/creating-vehicle-model/index.md +++ b/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/creating-vehicle-model/index.md @@ -235,7 +235,7 @@ colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release --package If your vehicle interface is ready, then you can add your vehicle_interface launch file in `vehicle_interface.launch.xml`. -Please check the [creating vehicle interface](../../creating-vehicle-interface-package/creating-a-vehicle-interface-for-an-ackermann-kinematic-model.md) page for more info. +Please check the [creating vehicle interface](../../creating-vehicle-interface-package/creating-vehicle-interface.md) page for more info. ### Launch planning simulator with your own vehicle diff --git a/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/index.md b/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/index.md index 2ce6d8a3f75..be4090063b2 100644 --- a/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/index.md +++ b/docs/how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/index.md @@ -22,7 +22,7 @@ - `_sensor_kit_description` - `_sensor_kit_launch` -Please refer to the [creating sensor model](./creating-sensor-model) page +Please refer to the [creating sensor model](./creating-sensor-model/index.md) page for creating your individual sensor model. For reference, @@ -49,7 +49,7 @@ sample_sensor_kit_launch/ - `_vehicle_description` - `_vehicle_launch` -Please consult the [creating vehicle model](./creating-vehicle-model) page +Please consult the [creating vehicle model](./creating-vehicle-model/index.md) page for creating your individual vehicle model. As a reference, diff --git a/docs/how-to-guides/integrating-autoware/creating-vehicle-interface-package/creating-vehicle-interface.md b/docs/how-to-guides/integrating-autoware/creating-vehicle-interface-package/creating-vehicle-interface.md index cbdbaf085b7..fd0d041d207 100644 --- a/docs/how-to-guides/integrating-autoware/creating-vehicle-interface-package/creating-vehicle-interface.md +++ b/docs/how-to-guides/integrating-autoware/creating-vehicle-interface-package/creating-vehicle-interface.md @@ -161,7 +161,7 @@ After you implement your vehicle interface, or you want to debug it by launching create a launch file of your vehicle interface, and include it to `vehicle_interface.launch.xml` which included in `_vehicle_launch` package that we forked and created -at [creating vehicle and sensor description page](../creating-vehicle-and-sensor-description/creating-vehicle-and-sensor-description.md). +at [creating vehicle and sensor model page](../creating-vehicle-and-sensor-model/index.md). Do not get confused. First, you need to create a launch file for your own vehicle interface module (like `my_vehicle_interface.launch.xml`) **and then include that to `vehicle_interface.launch.xml` which exists in another directory.** Here are the details. diff --git a/docs/how-to-guides/integrating-autoware/launch-autoware/index.md b/docs/how-to-guides/integrating-autoware/launch-autoware/index.md index 8449462be9a..4b721f1b58a 100644 --- a/docs/how-to-guides/integrating-autoware/launch-autoware/index.md +++ b/docs/how-to-guides/integrating-autoware/launch-autoware/index.md @@ -3,14 +3,14 @@ This section explains how to run your vehicle with Autoware. We will explain how to run and launch autoware with these modules: -- [Vehicle](./vehicle) -- [System](./system) -- [Map](./map) -- [Sensing](./sensing) -- [Localization](./localization) -- [Perception](./perception) -- [Planning](./planning) -- [Control](./control) +- [Vehicle](./vehicle/index.md) +- [System](./system/index.md) +- [Map](./map/index.md) +- [Sensing](./sensing/index.md) +- [Localization](./localization/index.md) +- [Perception](./perception/index.md) +- [Planning](./planning/index.md) +- [Control](./control/index.md) ## Pre-requirements of launching Autoware with real vehicle @@ -20,7 +20,7 @@ Please complete these steps for integration Autoware on your vehicle: - [Create your vehicle and sensor model](../creating-vehicle-and-sensor-model/index.md). - [Calibrate your sensors](../creating-vehicle-and-sensor-model/calibrating-sensors/index.md). - [Create your Autoware compatible vehicle interface](../creating-vehicle-interface-package/vehicle-interface.md). -- [Create your environment map](../creating-maps). +- [Create your environment map](../creating-maps/index.md). After the completion of these steps according to your individual vehicle, you are ready to use Autoware. @@ -170,7 +170,7 @@ If you don't want to use traffic light classifier, then you can disable it: + ``` -Please look at [Launch perception](./perception) page for detailed information. +Please look at [Launch perception](./perception/index.md) page for detailed information. ## Launch Autoware diff --git a/docs/how-to-guides/integrating-autoware/launch-autoware/localization/index.md b/docs/how-to-guides/integrating-autoware/launch-autoware/localization/index.md index 255c2ba280f..c6be60af61d 100644 --- a/docs/how-to-guides/integrating-autoware/launch-autoware/localization/index.md +++ b/docs/how-to-guides/integrating-autoware/launch-autoware/localization/index.md @@ -40,7 +40,7 @@ The current localization launcher implemented by TIER IV supports multiple local You can use YabLoc as a camera-based localization method. For more details on YabLoc, please refer to the [README of YabLoc](https://github.com/autowarefoundation/autoware.universe/blob/main/localization/yabloc/README.md) in autoware.universe. - Also, you can use Eagleye as a GNSS & IMU & wheel odometry-based localization method. For more details on Eagleye, please refer to the [Eagleye](./eagleye). + Also, you can use Eagleye as a GNSS & IMU & wheel odometry-based localization method. For more details on Eagleye, please refer to the [Eagleye](./eagleye/index.md). You can set `pose_source` argument on `tier4_localization_component.launch.xml`, for example, if you want to use eagleye as pose_source, @@ -60,7 +60,7 @@ The current localization launcher implemented by TIER IV supports multiple local - **`twist_source:`** This argument specifies the twist_estimator, currently supporting `gyro_odom` (default), and `eagleye`. By default, Autoware launches [gyro_odometer](https://github.com/autowarefoundation/autoware.universe/tree/main/localization/gyro_odometer) for twist estimator. - Also, you can use eagleye for the twist source, please refer to the [Eagleye](./eagleye). + Also, you can use eagleye for the twist source, please refer to the [Eagleye](./eagleye/index.md). If you want to change your twist source to eagleye, you can update `tier4_localization_component.launch.xml` like: ```diff diff --git a/docs/how-to-guides/integrating-autoware/overview.md b/docs/how-to-guides/integrating-autoware/overview.md index fc4ba5f05ef..a720897d885 100644 --- a/docs/how-to-guides/integrating-autoware/overview.md +++ b/docs/how-to-guides/integrating-autoware/overview.md @@ -83,7 +83,7 @@ Create `launch/sensing.launch.xml` that launches the interfaces of all the senso !!! note At this point, you are now able to run Autoware's Planning Simulator to do a basic test of your vehicle and sensing packages. - To do so, you need to build and install Autoware using your cloned repository. Follow the [steps for either Docker or source installation](../installation/) (starting from the dependency installation step) and then run the following command: + To do so, you need to build and install Autoware using your cloned repository. Follow the [steps for either Docker or source installation](../../installation/index.md) (starting from the dependency installation step) and then run the following command: ```bash ros2 launch autoware_launch planning_simulator.launch.xml vehicle_model:=YOUR_VEHICLE sensor_kit:=YOUR_SENSOR_KIT map_path:=/PATH/TO/YOUR/MAP @@ -120,7 +120,7 @@ This section briefly explains how to run your vehicle with Autoware. ### Install Autoware -Follow the [installation steps of Autoware](../../installation/). +Follow the [installation steps of Autoware](../../installation/index.md). ### Launch Autoware diff --git a/docs/how-to-guides/others/defining-temporal-performance-metrics.md b/docs/how-to-guides/others/defining-temporal-performance-metrics.md index b95d2c68e23..1d97e93526f 100644 --- a/docs/how-to-guides/others/defining-temporal-performance-metrics.md +++ b/docs/how-to-guides/others/defining-temporal-performance-metrics.md @@ -28,7 +28,7 @@ There are several tools available for evaluating Autoware according to the metri !!! note - TIER IV plans to measure Autoware, which is running according to [the tutorial](../../tutorials/), and provide a performance evaluation report periodically. An example of such a report can be found [here](https://tier4.github.io/CARET_report/), although it may not include all of the metrics listed. + TIER IV plans to measure Autoware, which is running according to [the tutorial](../../tutorials/index.md), and provide a performance evaluation report periodically. An example of such a report can be found [here](https://tier4.github.io/CARET_report/), although it may not include all of the metrics listed. The page does not aim to provide instructions on how to use these tools or measure the metrics. Its primary focus is on the metrics themselves, as they are more important than the specific tools used. These metrics retain their relevance regardless of the employed platform. @@ -53,11 +53,11 @@ In addition, it is recommended that metrics be determined incrementally from the ## List of sample metrics -This section demonstrates how to define metrics according to the policies explained and has lists of the metrics for Autoware launched according to [the tutorial](../../tutorials/). The section is divided into multiple subsections, each containing a model diagram and an accompanying list that explains the important temporal performance metrics. Each model is equipped with checkpoints that serve as indicators for these metrics. +This section demonstrates how to define metrics according to the policies explained and has lists of the metrics for Autoware launched according to [the tutorial](../../tutorials/index.md). The section is divided into multiple subsections, each containing a model diagram and an accompanying list that explains the important temporal performance metrics. Each model is equipped with checkpoints that serve as indicators for these metrics. The first subsection presents the top-level temporal performance metrics, which are depicted in the abstract structure of Autoware as a whole. The detailed metrics are not included in the model as they would add complexity to it. Instead, the subsequent section introduces the detailed metrics. The detailed metrics are subject to more frequent updates compared to the top-level ones, which is another reason for categorizing them separately. -Each list includes a column for the reference value. The reference value represents the observed value of each metric when Autoware is running according to [the tutorial](../../tutorials/). It is important to note that the reference value is not a required value, meaning that Autoware does not necessarily fail in [the tutorial](../../tutorials/) execution if certain metrics do not fulfill the reference value. +Each list includes a column for the reference value. The reference value represents the observed value of each metric when Autoware is running according to [the tutorial](../../tutorials/index.md). It is important to note that the reference value is not a required value, meaning that Autoware does not necessarily fail in [the tutorial](../../tutorials/index.md) execution if certain metrics do not fulfill the reference value. ### Top-level temporal performance metrics for Autoware diff --git a/docs/index.md b/docs/index.md index 6a5e09af6b7..bb1b77a3f88 100644 --- a/docs/index.md +++ b/docs/index.md @@ -12,33 +12,33 @@ Autoware is the world’s leading open-source project dedicated to autonomous dr ### Step into the World of Autoware -**Discover the Concept**: Start your Autoware journey by exploring the [Concept](design/autoware-concepts) pages. Here, you'll delve into the core ideas behind Autoware, understand its unique features and how it stands out in the field of autonomous driving technology. Learn about the principles guiding its development and the innovative solutions it offers. +**Discover the Concept**: Start your Autoware journey by exploring the [Concept](design/autoware-concepts/index.md) pages. Here, you'll delve into the core ideas behind Autoware, understand its unique features and how it stands out in the field of autonomous driving technology. Learn about the principles guiding its development and the innovative solutions it offers. ### Set Up Your Environment -**Install Autoware**: Once you have a grasp of the Autoware philosophy, it's time to bring it into your world. Visit our [Installation](installation) section for detailed, step-by-step instructions to seamlessly install Autoware and related tools in your environment. Whether you're a beginner or an expert, these pages are designed to guide you through a smooth setup process. +**Install Autoware**: Once you have a grasp of the Autoware philosophy, it's time to bring it into your world. Visit our [Installation](installation/index.md) section for detailed, step-by-step instructions to seamlessly install Autoware and related tools in your environment. Whether you're a beginner or an expert, these pages are designed to guide you through a smooth setup process. ### Dive Deeper -**Hands-on Experience**: After installation, head over to the [Tutorials](tutorials) pages. These tutorials are designed to provide you with hands-on experience with some simulations, allowing you to apply what you've learned and gain practical skills. From basic operations to advanced applications, these tutorials cover a wide range of topics to enhance your understanding of Autoware. +**Hands-on Experience**: After installation, head over to the [Tutorials](tutorials/index.md) pages. These tutorials are designed to provide you with hands-on experience with some simulations, allowing you to apply what you've learned and gain practical skills. From basic operations to advanced applications, these tutorials cover a wide range of topics to enhance your understanding of Autoware. -**Advanced Topics**: As you become more familiar with Autoware, the [How-to Guides](how-to-guides) will be your next destination. These pages delve into more advanced topics, offering deeper insights and more complex scenarios. They're perfect for those looking to expand their knowledge and expertise in specific areas of Autoware. Additionally, this section also covers methods for integrating Autoware with real vehicles, providing practical guidance for those seeking to apply Autoware in real-world settings. +**Advanced Topics**: As you become more familiar with Autoware, the [How-to Guides](how-to-guides/index.md) will be your next destination. These pages delve into more advanced topics, offering deeper insights and more complex scenarios. They're perfect for those looking to expand their knowledge and expertise in specific areas of Autoware. Additionally, this section also covers methods for integrating Autoware with real vehicles, providing practical guidance for those seeking to apply Autoware in real-world settings. ### Understand the Design -**Design Concepts**: For those interested in the architecture and design philosophy of Autoware, the [Design](design) pages are a treasure trove. Learn about the architectural decisions, design patterns, and the rationale behind the development of Autoware's various components. +**Design Concepts**: For those interested in the architecture and design philosophy of Autoware, the [Design](design/index.md) pages are a treasure trove. Learn about the architectural decisions, design patterns, and the rationale behind the development of Autoware's various components. ### More Information -**Datasets**: The [Datasets](datasets) pages are a crucial resource for anyone working with Autoware. Here, you'll find a collection of datasets that are compatible with Autoware, providing real-world scenarios and data to test and refine your autonomous driving solutions. +**Datasets**: The [Datasets](datasets/index.md) pages are a crucial resource for anyone working with Autoware. Here, you'll find a collection of datasets that are compatible with Autoware, providing real-world scenarios and data to test and refine your autonomous driving solutions. -**Support**: As you dive deeper into Autoware, you might encounter challenges or have questions. The [Support](support) section is designed to assist you in these moments. This area includes FAQs, community forums, and contact information for getting help with Autoware. It's also a great place to connect with other Autoware users and contributors, sharing experiences and solutions. +**Support**: As you dive deeper into Autoware, you might encounter challenges or have questions. The [Support](support/index.md) section is designed to assist you in these moments. This area includes FAQs, community forums, and contact information for getting help with Autoware. It's also a great place to connect with other Autoware users and contributors, sharing experiences and solutions. -**Competitions**: The [Competitions](autoware-competitions) pages are where excitement meets innovation. Autoware regularly hosts or participates in various competitions and challenges, providing a platform for users to test their skills, showcase their work, and contribute to the community. These competitions range from local to global scale, offering opportunities for both beginners and experts to engage and excel. Stay updated with upcoming events and take part in the advancement of autonomous driving technologies. +**Competitions**: The [Competitions](autoware-competitions/index.md) pages are where excitement meets innovation. Autoware regularly hosts or participates in various competitions and challenges, providing a platform for users to test their skills, showcase their work, and contribute to the community. These competitions range from local to global scale, offering opportunities for both beginners and experts to engage and excel. Stay updated with upcoming events and take part in the advancement of autonomous driving technologies. ### Contribute and Collaborate -**Become a Part of the Autoware Story**: Your journey with Autoware isn't just about learning and using; it's also about contributing and shaping the future of autonomous driving. The [Contributing](contributing) section is more than just a guide; it's an invitation to be part of something bigger. Whether you're a coder, a writer, or an enthusiast, your contributions can propel Autoware forward. Join us, and let's build the future together. +**Become a Part of the Autoware Story**: Your journey with Autoware isn't just about learning and using; it's also about contributing and shaping the future of autonomous driving. The [Contributing](contributing/index.md) section is more than just a guide; it's an invitation to be part of something bigger. Whether you're a coder, a writer, or an enthusiast, your contributions can propel Autoware forward. Join us, and let's build the future together. ## Related Documentations diff --git a/docs/installation/index.md b/docs/installation/index.md index b8f6aa1b9dc..9dea0e3ac9d 100644 --- a/docs/installation/index.md +++ b/docs/installation/index.md @@ -34,7 +34,7 @@ For details of how to enable object detection and traffic light detection/classi There are two ways to set up Autoware. Choose one according to your preference. -If any issues occur during installation, refer to the [Support page](../support). +If any issues occur during installation, refer to the [Support page](../support/index.md). ### 1. Docker installation @@ -58,10 +58,10 @@ For more information, refer to the [source installation guide](autoware/source-i Some other tools are required depending on the evaluation you want to do. For example, to run an end-to-end simulation you need to install an appropriate simulator. -For more information, see [here](related-tools). +For more information, see [here](related-tools/index.md). ## Additional settings for developers There are also tools and settings for developers, such as Shells or IDEs. -For more information, see [here](additional-settings-for-developers). +For more information, see [here](additional-settings-for-developers/index.md). diff --git a/docs/tutorials/scenario-simulation/planning-simulation/installation.md b/docs/tutorials/scenario-simulation/planning-simulation/installation.md index e9a386777b7..834be144a38 100644 --- a/docs/tutorials/scenario-simulation/planning-simulation/installation.md +++ b/docs/tutorials/scenario-simulation/planning-simulation/installation.md @@ -4,7 +4,7 @@ This document contains step-by-step instruction on how to build [AWF Autoware Co ## Prerequisites -1. [Autoware has been built and installed](../../../installation/) +1. [Autoware has been built and installed](../../../installation/index.md) ## How to build diff --git a/main.py b/main.py index 6952a83155e..f98979dd206 100644 --- a/main.py +++ b/main.py @@ -10,12 +10,12 @@ def drawio(image_path): @env.macro def create_relative_link(text, root_path): - path = os.path.relpath(root_path, env.page.url) + path = os.path.relpath(root_path, os.path.dirname(env.page.file.src_uri)) return f"[{text}]({path})" @env.macro def link_ad_api(name): - return create_relative_link(name, f"design/autoware-interfaces/ad-api/list/{name}") + return create_relative_link(name, f"design/autoware-interfaces/ad-api/list/{name}.md") @env.macro def resolve_msg_field(type, name, ext):