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 is broken #166

Closed
jordiferrero opened this issue Dec 9, 2022 · 3 comments · Fixed by #172
Closed

Documentation is broken #166

jordiferrero opened this issue Dec 9, 2022 · 3 comments · Fixed by #172
Labels
type: bug Something isn't working

Comments

@jordiferrero
Copy link
Contributor

jordiferrero commented Dec 9, 2022

Describe the bug

The read the docs equations are broken.
It does not show the "parsed" images of the maths equation.

The change that caused it is #163 by @jlaehne

image

https://docs.lumispy.org/en/latest/user_guide/signal_axis.html
I tried to figure out what changed, but I am not sure... can you have quick look?

@jordiferrero jordiferrero added the type: bug Something isn't working label Dec 9, 2022
@jlaehne
Copy link
Contributor

jlaehne commented Dec 9, 2022

On first sight, I do not see how #163 should have introduced that, but the same problem was reported for the HyperSpy documentation on gitter: https://gitter.im/hyperspy/hyperspy?at=6381155b655bc46025e30c63
and I then mentioned it in hyperspy/hyperspy#3050 (comment)

But it has not been resolved there either yet. I suspect it is something changed upstream on how sphinx handles latex-type equations.

@jordiferrero
Copy link
Contributor Author

OK. Then I guess there is nothing we can currently do... Thanks for the explanation.

@jlaehne
Copy link
Contributor

jlaehne commented Dec 9, 2022

Well, I think we should try to find out if it is a configuration issue of the imgmath plugin to sphinx.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants