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

Image and Latex Equations are not properly loaded/rendered #302

Closed
3 tasks done
ahmeddesokyebrahim opened this issue Jan 18, 2023 · 4 comments
Closed
3 tasks done
Assignees

Comments

@ahmeddesokyebrahim
Copy link
Contributor

Checklist

  • I've read the contribution guidelines.
  • I've searched other issues and no duplicate issues were found.
  • I've agreed with the maintainers that I can plan this task.

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

  • Check if autoware.github.io can access the images to be loaded (could be a broken path)
  • Check if autoware.github.io have proper rendering plugins for latex equations

Definition of done

To see the same output properly shown in Behavior path planner path generation documentation , as in github readme

@mehmetdogru
Copy link

cc: @kenji-miyake

@kenji-miyake
Copy link
Contributor

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.

For Latex, we need to use $$ instead of ```math.

cc @TakaHoribe (The author of autowarefoundation/autoware.universe#2428)

@mehmetdogru
Copy link

@ahmeddesokyebrahim could you please take a look at the proposed solution.

@ahmeddesokyebrahim
Copy link
Contributor Author

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 ahmeddesokyebrahim closed this as not planned Won't fix, can't repro, duplicate, stale Feb 3, 2023
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

No branches or pull requests

3 participants