-
Notifications
You must be signed in to change notification settings - Fork 243
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementImproving an existing featureImproving an existing feature
Description
Description of the problem
A tutorial script sometimes generates multiple images. The sphinx-gallery extension always chooses the first image as the thumbnail image. However, the first image may not be the best one.
Just take the colorbar documentation as an example.
Looking at the 5 examples. The last 3 examples don't show any colorbars, thus making the thumbnail images useless.
For these tutorials, it would to better if we can choose the best image as the thumbnail image. This can be done by adding a comment line # sphinx_gallery_thumbnail_number = <fig_number> in the docstring of the tutorial script. See the sphinx-gallery documentation for details.
I don't test it, but it should work. I think what we need to do:
- Go through all tutorial scripts and add the comment line if necessary
- Document it in the CONTRIBUTING.md file.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementImproving an existing featureImproving an existing feature
