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

Move to MathJax 3. #7961

Merged
merged 9 commits into from Jul 24, 2020
Merged

Move to MathJax 3. #7961

merged 9 commits into from Jul 24, 2020

Conversation

hameerabbasi
Copy link
Contributor

Subject: Move to MathJax 3 in Sphinx 4.0

Feature or Bugfix

  • Feature

Purpose

To use MathJax 3 and all its new features.

Relates

Closes #7425

@mitya57
Copy link
Contributor

mitya57 commented Jul 15, 2020

According to https://caniuse.com/#feat=es6, ES6 is supported by 96.71% of users' browsers. Maybe the polyfill is not needed?

doc/usage/extensions/math.rst Outdated Show resolved Hide resolved
Co-authored-by: Dmitry Shachnev <mitya57@users.noreply.github.com>
@tk0miya
Copy link
Member

tk0miya commented Jul 15, 2020

How about adding mathjax_version = (2 | 3) to Sphinx-3.x (of course, default is 2). Then who want to use mathjax-3 can start to use sooner. And we'll switches the default to 3 since Sphinx-4.0 release.

@tk0miya tk0miya added this to the 3.2.0 milestone Jul 15, 2020
@hameerabbasi
Copy link
Contributor Author

How about adding mathjax_version = (2 | 3) to Sphinx-3.x (of course, default is 2). Then who want to use mathjax-3 can start to use sooner. And we'll switches the default to 3 since Sphinx-4.0 release.

This is already possible just by switching the mathjax_path config. Would you prefer I document that for version 3.x?

@tk0miya
Copy link
Member

tk0miya commented Jul 15, 2020

Indeed. Please forget. I'm afraid to introduce a breaking change in 4.0. But I understand it is hard to reduce the impact (mainly for mathjax customized users). So +1 for this change.
It would be helpful to me if you add a CHANGES entry (because I'm not a native English speaker).

@tk0miya tk0miya modified the milestones: 3.2.0, 4.0.0 Jul 15, 2020
CHANGES Outdated Show resolved Hide resolved
@tk0miya
Copy link
Member

tk0miya commented Jul 16, 2020

According to https://caniuse.com/#feat=es6, ES6 is supported by 96.71% of users' browsers. Maybe the polyfill is not needed?

Is this done?

@hameerabbasi
Copy link
Contributor Author

Is this done?

Yes.

Copy link
Member

@tk0miya tk0miya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@mitya57 Do you have any comments?

@hameerabbasi
Copy link
Contributor Author

I'm not sure how to get the line length down while keeping the link. Thoughts?

Copy link
Contributor

@mitya57 mitya57 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One minor suggestion, otherwise it looks good to me.

doc/usage/extensions/math.rst Outdated Show resolved Hide resolved
Co-authored-by: Dmitry Shachnev <mitya57@users.noreply.github.com>
@tk0miya
Copy link
Member

tk0miya commented Jul 24, 2020

Now I updated a linter rule on #8002. Could you merge the 3.x branch and fold the line before an URL? It allows a very long literal string.

@hameerabbasi
Copy link
Contributor Author

There are a bunch of merge conflicts I'm not skillful enough to resolve... Should I cherry-pick the commit?

@tk0miya
Copy link
Member

tk0miya commented Jul 24, 2020

Oh, sorry. Please wait a moment. I'll merge in into master branch.

@tk0miya
Copy link
Member

tk0miya commented Jul 24, 2020

Done. Please merge the master branch into this.

@tk0miya tk0miya merged commit 208cb8a into sphinx-doc:master Jul 24, 2020
@tk0miya
Copy link
Member

tk0miya commented Jul 24, 2020

Thank you for your contribution! Merged 🎉

@hameerabbasi hameerabbasi deleted the mathjax-3 branch July 24, 2020 16:54
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 25, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants