8000 Switch from imgmath to mathjax · Issue #18828 · numpy/numpy · GitHub
[go: up one dir, main page]
Skip to content

Switch from imgmath to mathjax #18828

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.

Sign up for GitHub

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
Closed
rgommers opened this issue Apr 21, 2021 · 5 comments · Fixed by #19036
Closed

Switch from imgmath to mathjax #18828

rgommers opened this issue Apr 21, 2021 · 5 comments · Fixed by #19036
Labels
04 - Documentation 36 - Build Build related PR
Milestone
1.22.0 release

Comments

@rgommers
Copy link
Member
rgommers commented Apr 21, 2021 •
edited
Loading

For html doc builds we currently need to have LaTeX installed, which in general is a pain. In the Gitpod setup this also bloats the Docker image. sphinx.ext.imgmath needs LaTeX, sphinx.ext.mathjax does not.

Older discussion in gh-11753. And from #18822 (comment):

It was needed for sphinx.ext.imgmath to work without warnings. From my understanding, the :math: directives would not display anything without latex + dvisvgm.

(scipy uses sphinx.ext.mathjax so it does not run into this issue)

Ah thanks, that makes perfect sense now. The SciPy setup works fine, and I think is actually preferable given that we can avoid LaTeX:

I think the SciPy approach is preferred here.

Proposal: let's switch to mathjax and use https://github.com/scipy/scipy-mathjax as a submodule.
@rgommers
Copy link
Member Author

MathJAX is also alive and well, and is a NumFOCUS sponsored project. Which is useful; for SciPy it hasn't given any issues in the past four years, but if it does we know that the project is maintained.

@trallard trallard mentioned this issue Apr 22, 2021
Merged
5 tasks
@melissawm
Copy link
Member

I can take a look at this in the next few days - I think this is the right way to go.

@rgommers
Copy link
Member Author

Thanks Melissa!

@melissawm melissawm mentioned this issue May 19, 2021
Merged
@rgommers rgommers added this to the 1.21.0 release milestone May 21, 2021
@rgommers
Copy link
Member Author

I think it looks equal or better for everything I checked. Reducing the :nowrap: doesn't seem needed. E.g., compare:

In main:

image

After this PR:

image

@rgommers
Copy link
Member Author

Meant to post the above on the PR. Ah well.

@charris charris mentioned this issue Jun 13, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
04 - Documentation 36 - Build Build related PR
Projects
None yet
Milestone
1.22.0 release
Development

Successfully merging a pull request may close this issue.

MAINT: replace imgmath with mathjax for docs melissawm/numpy
3 participants
@charris @rgommers @melissawm
0