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

Jump to bottom

Support mathjax 3.0 #7425

Closed
choldgraf opened this issue Apr 6, 2020 · 9 comments
Closed

Support mathjax 3.0 #7425

choldgraf opened this issue Apr 6, 2020 · 9 comments
Labels
extensions help wanted type:enhancement enhance or introduce a new feature
Milestone
4.0.0

Comments

@choldgraf
Copy link
Contributor

MathJax 3.0 was released mid last year, and has a number of improvements - most notably on the speed of loading (something like an 80% decrease in load time). It would be great to get this into the Sphinx MathJax extension.

The MathJax upgrading docs suggest that it will not be trivial to upgrade, but it may be worth it given the performance and modularity improvements. What do folks think?
@choldgraf choldgraf added the type:enhancement enhance or introduce a new feature label Apr 6, 2020
@tk0miya tk0miya added this to the 4.0.0 milestone Apr 7, 2020
@tk0miya
Copy link
Member

tk0miya commented Apr 7, 2020

+1; Reasonable. But it seems some users need to change their configurations for MathJax. So some migration paths are needed.

@tk0miya
Copy link
Member

tk0miya commented Apr 7, 2020

Note: To keep compatibility, the default version of mathjax should be v2 during Sphinx-3.x. And I'm okay to change it to v3 on Sphinx-4.0.0.

@choldgraf
Copy link
Contributor Author

choldgraf commented Apr 8, 2020 •
edited

Agreed - I think an early first step is to add a configuration option for the mathjax version and provide docs for the best way to configure if it is version >= 3.0. The option can default to 2.x, and in the future it can be switched to 3.x

@thomas-nilsson-irfu
Copy link
Contributor

I am also in favour of having the new MathJax v3 support added, eventually that is..
However, in the meanwhile it may be worth to add an extra "attention" in the documentation* stating that the mathjax_path should not be set to point to the v3 of MathJax.

*Somewhere appropriate in: https://github.com/sphinx-doc/sphinx/blob/713bbf5cafa3fc5e143ced59dafe56f4b802ef80/doc/usage/extensions/math.rst#modsphinxextmathjax----render-math-via-javascript

@tk0miya
Copy link
Member

tk0miya commented Apr 8, 2020

For a while, I don't have time to work on this issue. So any pull requests are welcome!

@hameerabbasi hameerabbasi mentioned this issue Jul 15, 2020
Merged
@hameerabbasi
Copy link
Contributor

I've attempted to fix this in PR #7961.

@hameerabbasi
Copy link
Contributor

This was fixed by #7961

@tk0miya tk0miya closed this as completed Jul 27, 2020
@tk0miya
Copy link
Member

tk0miya commented Jul 27, 2020

Indeed!

@choldgraf
Copy link
Contributor Author

amazing, well done everybody and thanks @hameerabbasi :-)

@chrisjsewell chrisjsewell mentioned this issue May 10, 2021
Closed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 21, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
extensions help wanted type:enhancement enhance or introduce a new feature
Projects
None yet
Milestone
4.0.0
Development

No branches or pull requests
4 participants
@tk0miya @choldgraf @hameerabbasi @thomas-nilsson-irfu