fix(docs): remove spurious vertical scrollbar on display equations - #67
Open
jmoraispk wants to merge 1 commit into
Open
fix(docs): remove spurious vertical scrollbar on display equations#67jmoraispk wants to merge 1 commit into
jmoraispk wants to merge 1 commit into
Conversation
MathJax v3 (Sphinx 8) wraps display equations in <mjx-container>. The theme's overflow setting renders a small vertical scrollbar next to every equation. Set overflow-y: hidden while keeping overflow-x: auto for wide equations. The pre-existing .MathJax_Display rule targeted MathJax v2 and no longer matches.
Author
|
BEFORE: AFTER: |
Collaborator
|
Hi @jmoraispk, Thank you for this fix! It seems like this will be fixed upstream in the docs theme (pydata/pydata-sphinx-theme#2404). I will leave this PR open for now and we can revisit if this is still not fixed after a while. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Display equations in the documentation render with a small, spurious vertical scrollbar.
Cause: With the current Sphinx / MathJax v3 setup, each display equation is wrapped in an
<mjx-container>. The theme'soverflow: autocombined with a sub-pixel height mismatch between the theme font and MathJax's font triggers a vertical scrollbar on every equation.Fix: Set
overflow-y: hiddenonmjx-containerwhile keepingoverflow-x: autoso wide equations can still scroll horizontally. The pre-existing.MathJax_Displayrule targeted MathJax v2 and no longer matches the v3 markup.Changes
doc/source/_static/css/sionna.css: add anmjx-containeroverflow rule.Testing
Rebuilt the docs and verified in the browser that the display equations on the EM primer page no longer show a vertical scrollbar, and that wide equations still scroll horizontally.