Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
Fix alt and caption handling in Sphinx directives#29689
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Merged
Uh oh!
There was an error while loading.Please reload this page.
Conversation
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
tacaswell approved these changesFeb 27, 2025
story645 approved these changesFeb 27, 2025
We currently template new reST to be re-parsed after the plot iscreated, but incorrectly copied the `alt` and `caption` values when theywere wrapped.Additionally, change `figmpl` to use Sphinx/docutils' tag creationfunctions. These functions correctly escape attributes and so fixesinvalid HTML when alt text contains quotes.
timhoffm approved these changesFeb 28, 2025
ed3b739 intomatplotlib:main 40 of 41 checks passed
Uh oh!
There was an error while loading.Please reload this page.
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull requestFeb 28, 2025
timhoffm added a commit that referenced this pull requestMar 1, 2025
…689-on-v3.10.xBackport PR#29689 on branch v3.10.x (Fix alt and caption handling in Sphinx directives)
Sign up for freeto 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.
Uh oh!
There was an error while loading.Please reload this page.
PR summary
We currently template new reST to be re-parsed after the plot is created, but incorrectly copied the
altandcaptionvalues when they were wrapped.In the future, we should probably drop this template and directly create the nodes we need, but I assume that
TEMPLATEis not private right now for the purpose of letting people modify it.Additionally, change
figmplto use Sphinx/docutils' tag creation functions. These functions correctly escape attributes and so fixes invalid HTML when alt text contains quotes. I also dropped some attributes if they were empty (e.g., we no longer getstyle=""if those aren't specified.)For example, this is broken on thedark colour map image which has quoted colour map names in the alt text.
Fixes#29649
PR checklist