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

documentation on readthedocs fails to show rendered LaTeX #1267

Closed
parmentelat opened this issue Apr 7, 2017 · 10 comments · Fixed by #1371
Closed

documentation on readthedocs fails to show rendered LaTeX #1267

parmentelat opened this issue Apr 7, 2017 · 10 comments · Fixed by #1371
Labels
docs resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion.
Milestone

Comments

@parmentelat
Copy link

I would have expected the captions on the attached screenshot to be rendered as equations

screen shot 2017-04-07 at 10 09 40

@jasongrout
Copy link
Member

@SylvainCorlay - do you know what is going on there?

@jasongrout jasongrout added this to the 7.0 milestone Apr 8, 2017
@SylvainCorlay
Copy link
Member

Nope, but it seems specific to RTD. The problem does not occur on nbviewer: http://nbviewer.jupyter.org/github/ipython/ipywidgets/blob/master/docs/source/examples/Widget%20Styling.ipynb

@SylvainCorlay
Copy link
Member

MathJax is loaded on the page and typeset is called correctly

@jasongrout
Copy link
Member

By the way, here is the link for the original issue: http://ipywidgets.readthedocs.io/en/latest/examples/Widget%20Styling.html#Latex

@jasongrout
Copy link
Member

Looks to me like the issue is that RTD mathjax is configured with the default tex inline delimiters \( and \), while the notebook and nbviewer also have $. We should either change our example in the docs to \( and \), or fix our theme in RTD.

@jasongrout
Copy link
Member

fix our theme in RTD.

(Preferably this, since there are many notebooks that have $ delimiters)

@jasongrout
Copy link
Member

This should be fixed in #1363 - we'll wait until rtd updates to make sure.

@jasongrout
Copy link
Member

It appears that $x^2$ is still not recognized, but $$x^2$$ is. We'll need to fix that in the jupyter-alabaster theme, maybe.

@jasongrout
Copy link
Member

Actually, it looks like it's a setting in the mathjax sphinx extension, but not documented: https://github.com/sphinx-doc/sphinx/blob/0008d576fc82e196c8b7d3c82b7718ffb11b605d/sphinx/ext/mathjax.py#L79

@jasongrout
Copy link
Member

Never mind, that config option seems to be for math written in the docs (it wraps with those delimiters), not for configuring mathjax. It seems like there's not a way to adjust the mathjax config easily, so I'll just change the actual docs themselves.

jasongrout added a commit to jasongrout/ipywidgets that referenced this issue May 19, 2017
…s rendering.

Changes are a bit more because of some churn thanks to notebook saving.

Fixes jupyter-widgets#1267
@github-actions github-actions bot added the resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion. label Feb 13, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 13, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion.
Projects
None yet
3 participants