docs(mkdocs): enable instant loading of mathjax equations

[soblin]

Description

I fixed the rendering error mathjax equations of the autoware.universe documentation. (like this page: https://autowarefoundation.github.io/autoware.universe/main/planning/obstacle_avoidance_planner/docs/eb/)

It looks like the page should be reloaded on some environments (like mobile Firefox, google chrome desktop).

Currently, autoware-documentation and autoware.universe documentation do not seem to support instant loading of math equations.
related: squidfunk/mkdocs-material#2530

How to reproduce

When you open the home page of obstacle_avoidance_planner and then go to the details of getEBTrajectory part by clicking the link on here, you are likely to see the math equations not rendered first. Then you need to reload the page to get the equations rendered.

After this PR

You do not need to reload the detail page to get the equations rendered.

Tests performed

Not applicable.

Effects on system behavior

Not applicable.

Pre-review checklist for the PR author

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

• I've confirmed the contribution guidelines.
• The PR follows the pull request guidelines.

In-review checklist for the PR reviewers

The PR reviewers must check the checkboxes below before approval.

• The PR follows the pull request guidelines.

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.

[soblin]

It looks like regardless of this PR the documentation page should be reloaded to render math equations. I'll close this.

[github-actions]

Documentation URL: https://autowarefoundation.github.io/autoware.universe/pr-3846/
Modified URLs:

[kenji-miyake]

Sync this file is synced with autoware-documentation, could you edit either of the following?

autoware.universe/.github/sync-files.yaml

Lines 92 to 99 in 3950f81

	- source: mkdocs.yaml
	pre-commands: |
	sd "Autoware Documentation" "Autoware Universe Documentation" {source}
	sd "autoware-documentation" "autoware.universe" {source}
	sd "repo_url: .*" "repo_url: https://github.com/autowarefoundation/autoware.universe" {source}
	sd "/edit/main/docs/" "/edit/main/" {source}
	sd "docs_dir: .*" "docs_dir: ." {source}
	sd "assets/(\w+)" "docs/assets/\$1" {source}

https://github.com/autowarefoundation/autoware-documentation/blob/445a776ca7207e305371daf43376b7704ba9073d/mkdocs.yaml

[soblin]

So should I create a PR to autoware-documentation as well that apply the same change to mkdocs.yaml ?

[kenji-miyake]

I think it's better.
If you want to apply this change only to autoware.universe, please update sync-files.yaml instead.

[soblin]

Nice, I was just making an another PR to autoware-documentation because same behavior is happening there too ! And that should be fixed with the same change as this PR.
autowarefoundation/autoware-documentation#380

[kenji-miyake]

Great. I'll take a look.

[kenji-miyake]

Also, could you specify which page/part of the documentation has an error?

[soblin]

@kenji-miyake Very weirdly, in some cases math equations are not rendered across all the documentation. For example when you opened the obstacle avoidance planner documentation, and then go to the link attached with "here" in the last sentence:

More details about elastic band can be seen here

On my google chrome desktop and firefox on iPhone the math equations are not rendered at first, and I need to reload the page to see them. On firefox desktop, the equations are rendered from the beginning.
I think this should be fixed for developers who are interested in the implementation of autoware.

[kenji-miyake]

I see, I was able to reproduce the behavior.

[kenji-miyake]

[optional] Could you add sync settings for this file just in case?

Related: https://github.com/autowarefoundation/autoware.universe/pull/3846/files#r1207080761