doc: add thumbnails for skipped gallery and tutorial examples (fixes #17479)#31450
Conversation
Several gallery examples that use the `_sgskip` suffix (excluded from documentation build execution) were missing thumbnails, causing placeholder grey boxes to appear in the gallery index page. Add sphinx_gallery_thumbnail_path directives to 9 examples, along with 6 new SVG thumbnail images in doc/_static/ that visually represent what each example does: - animation/frame_grabbing_sgskip: film-strip animation thumbnail - event_handling/ginput_manual_clabel_sgskip: contour plot with cursor - event_handling/pong_sgskip: pong game court thumbnail - misc/hyperlinks_sgskip: scatter plot with link indicators - misc/image_thumbnail_sgskip: reuse existing stinkbug.png - misc/multiprocess_sgskip: real-time producer/plotter diagram - misc/print_stdout_sgskip: terminal + line plot thumbnail - mplot3d/wire3d_animation_sgskip: reuse existing demo_mplot3d.png - widgets/lasso_selector_demo_sgskip: scatter with lasso selection Closes matplotlib#17479
|
Thank you for opening your first PR into Matplotlib! If you have not heard from us in a week or so, please leave a new comment below and that should bring it to our attention. Most of our reviewers are volunteers and sometimes things fall through the cracks. We also ask that you please finish addressing any review comments on this PR and wait for it to be merged (or closed) before opening a new one, as it can be a valuable learning experience to go through the review process. You can also join us on gitter for real-time discussion. For details on testing, writing docs, and our review process, please see the developer guide. We strive to be a welcoming and open project. Please follow our Code of Conduct. |
|
Hello @ayeshakhalid192007-dev. I see from your profile you have a strong interest in building autonomous AI agents. Was this PR AI generated? |
|
@rcomer Thanks for reviewing my PR. I appreciate your interest in my work on autonomous AI Agents. No, this PR was not AI-generated. I have been working on optimizing the current implementation, and these changes reflect some of those improvements. |
What Does This PR Do
Adds missing gallery thumbnails for examples that use the
_sgskipsuffix and are therefore excluded from documentation build execution. These examples were showing placeholder grey boxes in the gallery index page, which could confuse users into thinking the examples were broken.Root Cause
Examples with
_sgskipin their filename are intentionally skipped during the Sphinx Gallery build (because they require interactive input, external programs like FFmpeg, or intentionally take too long). Since sphinx-gallery never executes them, it cannot auto-generate a thumbnail image. Without asphinx_gallery_thumbnail_pathdirective, these examples display an empty placeholder thumbnail.Changes
# sphinx_gallery_thumbnail_path = '...'directive to 9 skipped examplesdoc/_static/, each designed to visually represent what the example demonstrates_static/(no new file needed):image_thumbnail_sgskipusesstinkbug.png(an image being thumbnailed — fitting)wire3d_animation_sgskipusesdemo_mplot3d.png(existing 3D plot image)Expected Impact
Type of Change
Checklist
multipage_pdf.py(sphinx_gallery_thumbnail_path)_static/images (no unnecessary new files)Fixes #17479