Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

DOC: Fix thumbnail title for sphinx gallery#25508

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
timhoffm merged 2 commits intomatplotlib:mainfromStefRe:fix/thumbnail_text
Mar 22, 2023

Conversation

StefRe
Copy link
Contributor

@StefReStefRe commentedMar 19, 2023•
edited
Loading

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 bysphinx-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

  • [N/A] Has pytest style unit tests (andpytest passes)
  • Documentation is sphinx and numpydoc compliant (the docs shouldbuild without error).
  • [N/A] New plotting related features are documented with examples.

Release Notes

  • [N/A] New features are marked with a.. versionadded:: directive in the docstring and documented indoc/users/next_whats_new/
  • [N/A] API changes are marked with a.. versionchanged:: directive in the docstring and documented indoc/api/next_api_changes/
  • [N/A] Release notes conform with instructions innext_whats_new/README.rst ornext_api_changes/README.rst

Sphinx Gallery 0.11.0 left RST formatting characters in the thumbnailtitles. This was fixed in version 0.12.2 for most cases bygithub.com/sphinx-gallery/sphinx-gallery/pull/1005, which doesn'tcover default roles. So to restore the previous behavior we needto explicitely a role.
Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
Copy link
Member

@jklymakjklymak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I don't suppose there is appetite for linking to the main library way of doing these things while we are on this page? Eghttps://matplotlib.org/stable/gallery/subplots_axes_and_figures/colorbar_placement.html

@ksundenksunden added this to thev3.7-doc milestoneMar 21, 2023
@StefRe
Copy link
ContributorAuthor

I don't suppose there is appetite for linking to the main library way of doing these things while we are on this page?

@jklymak I didn't look at the content of the example, just the way the title displays in the thumbnail. So I'd prefer not to change the content of the example in this PR. This is mainly because I've never used theaxes_grid1 toolkit myself and frankly speaking don't know what parts of the toolkit could not also be more or less easily covered by the main library. Looking athttps://matplotlib.org/devdocs/api/_as_gen/mpl_toolkits.axes_grid1.axes_grid.html#module-mpl_toolkits.axes_grid1.axes_grid, it also seems that the docs could use a little makeover.

@timhoffmtimhoffm merged commit4b42d7f intomatplotlib:mainMar 22, 2023
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull requestMar 22, 2023
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull requestMar 22, 2023
@StefReStefRe deleted the fix/thumbnail_text branchMarch 22, 2023 13:51
rcomer added a commit that referenced this pull requestMar 22, 2023
…508-on-v3.7.1-docBackport PR#25508 on branch v3.7.1-doc (DOC: Fix thumbnail title for sphinx gallery)
rcomer added a commit that referenced this pull requestMar 22, 2023
…508-on-v3.7.xBackport PR#25508 on branch v3.7.x (DOC: Fix thumbnail title for sphinx gallery)
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@tacaswelltacaswelltacaswell left review comments

@QuLogicQuLogicQuLogic left review comments

@jklymakjklymakjklymak approved these changes

@timhoffmtimhoffmtimhoffm approved these changes

Assignees
No one assigned
Projects
None yet
Milestone
v3.7-doc
Development

Successfully merging this pull request may close these issues.

[Doc]: Thumbnail title in gallery show rst formatting characters
6 participants
@StefRe@tacaswell@QuLogic@jklymak@timhoffm@ksunden
[8]ページ先頭
©2009-2025 Movatter.jp