fix(docs): remove spurious vertical scrollbar on display equations#1162
Open
jmoraispk wants to merge 1 commit into
Open
fix(docs): remove spurious vertical scrollbar on display equations#1162jmoraispk wants to merge 1 commit into
jmoraispk wants to merge 1 commit into
Conversation
The pydata-sphinx-theme sets 'overflow: auto' on 'div.math mjx-container', which makes MathJax v3 render a small vertical scrollbar next to every display equation. Override overflow-y to hidden (matching the theme's selector so it wins the cascade) while preserving horizontal scrolling for wide equations.
Author
|
BEFORE: AFTER: |
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
1 participant
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
Every display equation in the documentation renders with a small, spurious vertical scrollbar.
Cause: With the current Sphinx / MathJax v3 setup,
pydata-sphinx-themeappliesoverflow: autotodiv.math mjx-container. A sub-pixel height mismatch between the theme font and MathJax's font then triggers a vertical scrollbar on every equation.Fix: Override
overflow-y: hiddenusing the same selector so it wins the cascade, while keepingoverflow-x: autoso wide equations can still scroll horizontally.Changes
doc/source/_static/custom.css: add a singlediv.math mjx-container { overflow-y: hidden; }rule.Testing
Rebuilt the docs and verified in the browser that none of the display equations on the EM primer page show a vertical scrollbar, and that wide equations still scroll horizontally.