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 rendering with sphinx 5.3.0 #527

Merged
merged 3 commits into from
Nov 24, 2022

Conversation

Moritz-Alexander-Kern
Copy link
Member

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

Bug

Documenation build with sphinx 5.3.0 (5.2.3 works) does not render math expressions properly, see:
https://elephant.readthedocs.io/en/v0.11.2/reference/_toctree/signal_processing/elephant.signal_processing.cross_correlation_function.html#elephant.signal_processing.cross_correlation_function

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.

@Moritz-Alexander-Kern Moritz-Alexander-Kern added build html This will trigger the upload of the docs html files as artifact in github actions bugfix Fix for an indentified bug. labels Nov 16, 2022
Copy link
Member Author

@Moritz-Alexander-Kern Moritz-Alexander-Kern left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

build wheels

@coveralls
Copy link
Collaborator

coveralls commented Nov 16, 2022

Coverage Status

Coverage increased (+0.3%) to 87.564% when pulling 626948b on INM-6:fix/math_in_docs into 3e169d4 on NeuralEnsemble:master.

@Moritz-Alexander-Kern Moritz-Alexander-Kern added this to the v0.12.0 milestone Nov 16, 2022
Copy link
Member Author

@Moritz-Alexander-Kern Moritz-Alexander-Kern left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

build wheels

@mdenker mdenker merged commit d12d80f into NeuralEnsemble:master Nov 24, 2022
@Moritz-Alexander-Kern Moritz-Alexander-Kern deleted the fix/math_in_docs branch July 21, 2023 12:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bugfix Fix for an indentified bug. build html This will trigger the upload of the docs html files as artifact in github actions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants