Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: warning for relative links #538

Merged
merged 1 commit into from
Apr 23, 2024

Conversation

isamu-takagi
Copy link
Contributor

@isamu-takagi isamu-takagi commented Apr 22, 2024

Description

Fix a warning for relative links when generating documentation. Below are some of the warnings.

$ mike deploy HEAD
...
INFO    -  Doc file 'how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors/lidar-lidar-calibration/index.md' contains an unrecognized relative link
           '../extrinsic-manual-calibration', it was left as is. Did you mean '../extrinsic-manual-calibration/index.md'?
INFO    -  Doc file 'how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors/lidar-lidar-calibration/index.md' contains an unrecognized relative link
           '../extrinsic-manual-calibration', it was left as is. Did you mean '../extrinsic-manual-calibration/index.md'?
INFO    -  Doc file 'how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/creating-sensor-model/index.md' contains an unrecognized relative link '../calibrating-sensors', it
           was left as is. Did you mean '../calibrating-sensors/index.md'?
WARNING -  Doc file 'how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/creating-vehicle-model/index.md' contains a relative link
           '../../creating-vehicle-interface-package/creating-a-vehicle-interface-for-an-ackermann-kinematic-model.md', but the target
           'how-to-guides/integrating-autoware/creating-vehicle-interface-package/creating-a-vehicle-interface-for-an-ackermann-kinematic-model.md' is not found among documentation files.
...

Pre-review checklist for the PR author

The PR author must check the checkboxes below when creating the PR.

In-review checklist for the PR reviewers

The Reviewers must check the checkboxes below before approval.

Post-review checklist for the PR author

The PR author must check the checkboxes below before merging.

  • There are no open discussions or they are tracked via tickets.

After all checkboxes are checked, anyone who has write access can merge the PR.

Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp>
@isamu-takagi isamu-takagi self-assigned this Apr 22, 2024
@isamu-takagi isamu-takagi changed the title fix: warning for relative links. fix: warning for relative links Apr 22, 2024
Copy link
Member

@ismetatabay ismetatabay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have tested it, and this pull request resolves the warnings. Thank you.
LGTM

@isamu-takagi isamu-takagi merged commit 9cf4183 into autowarefoundation:main Apr 23, 2024
11 of 13 checks passed
@isamu-takagi isamu-takagi deleted the fix/relative-links branch April 23, 2024 12:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants