Add gif extension to Sphinx-Gallery scraper #4403
Conversation
Codecov Report
@@ Coverage Diff @@
## main #4403 +/- ##
=======================================
Coverage 95.82% 95.82%
=======================================
Files 97 97
Lines 20874 20875 +1
=======================================
+ Hits 20002 20004 +2
+ Misses 872 871 -1 |
adeak
changed the title
|
This should be good to go, @akaszynski can you take a look? |
There was a problem hiding this comment.
This was intentional at one point -- I need to come back to this when I have more time and look into this.
Another great person to review would be @larsoner
banesullivan
changed the title
We've had problems in the past generating latex documentation when using gifs. I think we purposely changed the extension to 'png' to avoid this issue. |
|
More than just LaTeX if I remember correctly -- I think it had side effects on the preview cards on the gallery page too. I remember there being a few issues. The sphinx-gallery team would know how to best handle this |
|
I didn't consider those cases, thanks for pointing that out! I just was thinking that maybe some browsers can't identify that .png files are actually GIFs and they wouldn't show properly. |
|
SG should handle GIFs fine on gallery pages nowadays https://mne.tools/dev/auto_tutorials/index.html#source-localization-and-inverses |
|
... no idea on the LaTeX front, though. To me if it's not handled properly it should probably be considered a Sphinx (not sphinx-gallery) issue -- it seems like Sphinx should detect that it's not LaTeX-friendly and just take the first frame and embed as PNG or something. But if this is too onerous for them we could triage based on builder type in SG (ugly but would work). |
According to Sphinx Gallery - Advanced usage, these guys support it. Just checked a local build and downloaded the artifacts... this PR doesn't rename the |
|
In commit 09de6c0 it's working well, so it must still be getting the examples from the cache. I'm not sure how to reset it, or if that's even possible for just this PR. |
Weird, because I cleaned everything locally. I'm going to push a trivial commit to ensure the GIF example is rebuilt. |
|
Locally verified this works. Environment issue on my end: GitHub is having a rough day, I'll ensure we get this to run properly. |
|
Gallery looks fantastic as well: Really great to see animated thumbnails. |
|
Let me know if there is any remaining ambiguity from the SG end but otherwise +1 for merge. Agreed the GIFs look nice 👀 🍬 |
* Add gif extension * Reset cache * Add test for GIFs * Revert cache regeneration * Fix test * use cells for the example --------- Co-authored-by: Alex Kaszynski <akascap@gmail.com>
* Add PyHyperbolic3D as an external example (#4420) * Add PyHyperbolic3D as an external example * Reduce Gif file size * Use 128 color * optimize and scale --------- Co-authored-by: Alex Kaszynski <akascap@gmail.com> * Fix merge dataset (#4414) * convert back to polydata using extact_geometry * improved readability * branch for performance * add in verts * revert #4407 into this branch * Avoided omission of two letters. --------- Co-authored-by: Tetsuo Koyama <tkoyama010@gmail.com> * Remove SKIP in docstrings (#4419) * remove SKIPs * remove the rest of skips * minor fixes * Fix active scalars and pass point data in `to_tetrahedra` for `RectilinearGrid` (#4406) * add failing test * fix active scalars for cell data * pass point data, deprecate use of pass_cell_data * document parameter --------- Co-authored-by: Alex Kaszynski <akascap@gmail.com> * Add gif extension to Sphinx-Gallery scraper (#4403) * Add gif extension * Reset cache * Add test for GIFs * Revert cache regeneration * Fix test * use cells for the example --------- Co-authored-by: Alex Kaszynski <akascap@gmail.com> * bump version to v0.39.1 --------- Co-authored-by: Tetsuo Koyama <tkoyama010@gmail.com> Co-authored-by: MatthewFlamm <39341281+MatthewFlamm@users.noreply.github.com> Co-authored-by: Alex Fernandez <21alex295@gmail.com>
Overview
Sphinx image scrapper is returning GIF files with PNG extension. This PR fixes it.
Closes #4397