{{ message }}
DOC: Fix thumbnail title for sphinx gallery - #25508
Merged
Merged
Conversation
Sphinx Gallery 0.11.0 left RST formatting characters in the thumbnail titles. This was fixed in version 0.12.2 for most cases by github.com/sphinx-gallery/sphinx-gallery/pull/1005, which doesn't cover default roles. So to restore the previous behavior we need to explicitely a role.
QuLogic
reviewed
Mar 20, 2023
Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
jklymak
approved these changes
Mar 21, 2023
jklymak
reviewed
Mar 21, 2023
jklymak
left a comment
jklymak
left a comment
Member
There was a problem hiding this comment.
I don't suppose there is appetite for linking to the main library way of doing these things while we are on this page? Eg https://matplotlib.org/stable/gallery/subplots_axes_and_figures/colorbar_placement.html
Contributor
Author
timhoffm
approved these changes
Mar 22, 2023
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Mar 22, 2023
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Mar 22, 2023
rcomer
added a commit
that referenced
this pull request
Mar 22, 2023
…508-on-v3.7.1-doc Backport PR #25508 on branch v3.7.1-doc (DOC: Fix thumbnail title for sphinx gallery)
rcomer
added a commit
that referenced
this pull request
Mar 22, 2023
…508-on-v3.7.x Backport PR #25508 on branch v3.7.x (DOC: Fix thumbnail title for sphinx gallery)
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
6 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.
PR Summary
Sphinx Gallery 0.11.0 left RST formatting characters in the thumbnail titles. This was fixed in version 0.12.2 for most cases by sphinx-gallery/sphinx-gallery/pull/1005, which doesn't cover default roles. So to restore the previous behavior we need to explicitely specify a role.
Closes #23884.
PR Checklist
Documentation and Tests
pytestpasses)Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst