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

Fix/math in docs #59

Merged
merged 4 commits into from
Feb 16, 2023
Merged

Fix/math in docs #59

merged 4 commits into from
Feb 16, 2023

Conversation

Moritz-Alexander-Kern
Copy link
Contributor

@Moritz-Alexander-Kern Moritz-Alexander-Kern commented Nov 29, 2022

Bug

Documentation build with sphinx 5.3.0 (5.2.3 works) does not render math expressions properly, see:

See: https://viziphant.readthedocs.io/en/latest/toctree/gpfa/viziphant.gpfa.plot_trajectories_spikeplay.html#viziphant.gpfa.plot_trajectories_spikeplay

Fix

In previous Sphinx releases, mathjax was the default html math renderer. With release 5.3.0, math expressions are no longer rendered properly, defining mathjax as the renderer fixes this Issue.

  • defined mathjax as html renderer
  • removed sphinx extension imgmath

See result: https://viziphant--59.org.readthedocs.build/en/59/toctree/gpfa/viziphant.gpfa.plot_trajectories_spikeplay.html#viziphant.gpfa.plot_trajectories_spikeplay

See also: NeuralEnsemble/elephant#527

@mdenker mdenker merged commit 625193f into master Feb 16, 2023
@Moritz-Alexander-Kern Moritz-Alexander-Kern deleted the fix/math_in_docs branch July 21, 2023 12:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants