docs: use MathJax SVG renderer for HTML equations#1324
Merged
Conversation
cf8c449 to
f9a2a15
Compare
schaubh
approved these changes
Mar 11, 2026
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
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.
Description
This PR addresses a global HTML documentation rendering issue where some math expressions show vertically misaligned characters in certain local browser/font environments.
The issue is not module-specific. It affects equation rendering across Basilisk docs because it originates in the shared Sphinx/MathJax configuration.
What changed
Updated:
docs/source/conf.pySwitched MathJax output mode from CHTML to SVG:
mathjax_path = "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-svg.js"mathjax3_config = {"svg": {"fontCache": "global"}}No simulation models, algorithms, message interfaces, or unit tests are modified.
RFT (Rendering Fault Type)
RFT-Category: Documentation rendering / browser typography mismatch
Observed failure mode:
B_{overlap}may render with inconsistent baseline alignment between letters in the subscripted token.Why this happens:
Why SVG fixes it:
Scope and Impact
Affected scope
Not affected
Verification
Checks performed:
tex-svg.js).