viziphant icon indicating copy to clipboard operation
viziphant copied to clipboard

Published 20 hours ago • verified publisher icon INM-6

Fix/math in docs

Open Moritz-Alexander-Kern opened this issue 2 years ago • 0 comments

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: https://github.com/NeuralEnsemble/elephant/pull/527

Moritz-Alexander-Kern avatar Nov 29 '22 15:11 Moritz-Alexander-Kern