Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[Doc]: Thumbnail title in gallery show rst formatting characters #23884

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
StefRe opened this issue Sep 13, 2022 · 8 comments · Fixed by #25508
Closed

[Doc]: Thumbnail title in gallery show rst formatting characters #23884

StefRe opened this issue Sep 13, 2022 · 8 comments · Fixed by #25508

Comments

@StefRe
Copy link
Contributor

StefRe commented Sep 13, 2022

Documentation Link

https://matplotlib.org/devdocs/tutorials/index.html#intermediate

Problem

for instance here:

image

This is caused by sphinx-gallery/sphinx-gallery#906. I'm not sure if this can be fixed on matplotlib's side or must be addressed in sg. See also sphinx-gallery/sphinx-gallery#998.

Suggested improvement

The title should be just origin and extent in imshow without *, ~.Axes. prefix and backticks.

@timhoffm
Copy link
Member

Agreed that we should not use markup in headings.

Maybe we can make the wording more explicit though. How about

imshow(): Behavior of parameters origin and extent

@QuLogic
Copy link
Member

QuLogic commented Sep 13, 2022

It would be best if this were fixed in sphinx-gallery; never know if we might accidentally introduce formatting in a title somewhere later, even if we fix them all now.

@timhoffm
Copy link
Member

The question generally is how? While emphasis may be viable, do you really want to have links, literal code etc in a title?

@QuLogic
Copy link
Member

QuLogic commented Sep 14, 2022

We already disallow links in headings, but it's only enforced when we notice it. For the sphinx-gallery cards, it'd be better to strip all formatting.

@StefRe
Copy link
Contributor Author

StefRe commented Sep 14, 2022

My intention when opening this issue was not so much to change the examples and tutorials but restore the behavior of sg < 0.11.0 where any formatting was stripped from the title, see the old docs:

grafik

The question was more if this could be achieved by some CSS voodoo on the part of matplotlib instead of waiting for a fix in sg.

@timhoffm
Copy link
Member

This would need to be addressed in Sphinx-gallery.

@StefRe
Copy link
Contributor Author

StefRe commented Sep 14, 2022

I've opened an issue there: sphinx-gallery/sphinx-gallery#1002

@StefRe
Copy link
Contributor Author

StefRe commented Mar 19, 2023

The original example above has no thumbnail anymore (due to #25395). With Sphinx Gallery 0.12.2 and sphinx-gallery/sphinx-gallery#1108 there's only a single case left which will be fixed by #25508 .

@QuLogic QuLogic added this to the v3.7.2 milestone Mar 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants