build(mkdocs): fix mathjax rendering #380
Conversation
Signed-off-by: Mamoru Sobue <mamoru.sobue@tier4.jp>
|
It looks like regardless of this PR the documentation page should be reloaded to render math equations. |
kenji-miyake
changed the title
… sync conflict Signed-off-by: Mamoru Sobue <mamoru.sobue@tier4.jp>
soblin
added
type:documentation
| @@ -75,7 +77,8 @@ markdown_extensions: | |||
| - plantuml_markdown: | |||
| server: http://www.plantuml.com/plantuml | |||
| format: svg | |||
| - pymdownx.arithmatex | |||
| - pymdownx.arithmatex: | |||
| generic: true | |||
There was a problem hiding this comment.
Could you tell me the reference documentation for this?
There was a problem hiding this comment.
And what was the problem? Is this also related to the MathJax issue?
There was a problem hiding this comment.
Oh I did not pay much attention to it. According to Arithmatex documentation, this option seems to offer different html rendering approach of mathjax equation. I guess generic: true may not be a necessary change this time.
There was a problem hiding this comment.
So do you want to remove it?
| generic: true |
There was a problem hiding this comment.
I tested on my local machine, and found out genetic: true is a must option for rendering mathjax. Without this option they were not rendered even if I reloaded the page many times.
I think I can readily ship this PR once I checked https://autowarefoundation.github.io/autoware-documentation/pr-380/ !
There was a problem hiding this comment.
Understood. Thank you for testing it!
|
Documentation URL: https://autowarefoundation.github.io/autoware-documentation/pr-380/ |
|
I confirmed that compared to current main branch page, the deployed page works on
by visiting how to guides and then moving to "Customizing for differential drive vehicle" part manually and checking the mathjax |
* feat(mkdocs): fix mathjax rendering Signed-off-by: Mamoru Sobue <mamoru.sobue@tier4.jp> * apply same change to mkdocs.yaml with autoware.universe#3846 to avoid sync conflict Signed-off-by: Mamoru Sobue <mamoru.sobue@tier4.jp> --------- Signed-off-by: Mamoru Sobue <mamoru.sobue@tier4.jp> Signed-off-by: guiping meng <alan.meng@autocore.ai>
Description
Equations in this page were not rendered, so I fixed it.
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.
After all checkboxes are checked, anyone who has write access can merge the PR.