We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
In the Behavior path planner path generation documentation , there are some images and latex equations are not loaded properly.
However, the same image and equations are shown correctly for the same document but in github readme
I will be very beneficial if this can be fixed in autoware documentation as well.
Fix the image and latex equations loading for having better reading and understanding of autware documentation
To see the same output properly shown in Behavior path planner path generation documentation , as in github readme
The text was updated successfully, but these errors were encountered:
cc: @kenji-miyake
Sorry, something went wrong.
Related: autowarefoundation/autoware.universe#1568
This is because of the difference between the Markdown grammar of "GitHub" and "Material for MkDocs".
For images, the format <img src="./image/path_shifter.png" width="800"> cannot be used. Please use [path_shifter](./image/path_shifter.png) instead.
<img src="./image/path_shifter.png" width="800">
[path_shifter](./image/path_shifter.png)
For Latex, we need to use $$ instead of ```math.
$$
```math
cc @TakaHoribe (The author of autowarefoundation/autoware.universe#2428)
@ahmeddesokyebrahim could you please take a look at the proposed solution.
I have tested the proposed solution by @kenji-miyake in this branch : https://github.com/ahmeddesokyebrahim/autoware.universe/blob/ahmedebrahim/aw-doc/path-generation-readme/planning/behavior_path_planner/behavior_path_planner_path_generation.md
And it looks like that we either sacrifice github doc or github readme.
I will not create a PR and close the issue with this comment.
ahmeddesokyebrahim
No branches or pull requests
Checklist
Description
In the Behavior path planner path generation documentation , there are some images and latex equations are not loaded properly.
However, the same image and equations are shown correctly for the same document but in github readme
I will be very beneficial if this can be fixed in autoware documentation as well.
Purpose
Fix the image and latex equations loading for having better reading and understanding of autware documentation
Possible approaches
Definition of done
To see the same output properly shown in Behavior path planner path generation documentation , as in github readme
The text was updated successfully, but these errors were encountered: