DOC: Use video files for saving animations #27797
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
QuLogic
force-pushed
the
doc-anim-videos
branch
from
1673efb to
31ae2b4
Compare
Member
|
Bumping to 3.10 as the needed PR sphinx-gallery/sphinx-gallery#1243 is not yet in. |
timhoffm
approved these changes
Jul 26, 2024
Because the default is Base64-encoded frames of PNGs, this should save a substantial amount of space in the resulting docs.
Member
Author
|
As a demo, try any of the examples linked in this section: https://output.circle-artifacts.com/output/job/8326ca38-b2a4-4802-a257-07ee95303037/artifacts/0/doc/build/html/gallery/index.html#animation |
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Aug 9, 2024
ksunden
added a commit
that referenced
this pull request
Aug 9, 2024
…797-on-v3.9.x Backport PR #27797 on branch v3.9.x (DOC: Use video files for saving animations)
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR summary
Because the default is Base64-encoded frames of PNGs, this should save a substantial amount of space in the resulting docs. We may want to increase the bitrate slightly, though most of the videos seem clear enough to me.
This currently depends on sphinx-gallery/sphinx-gallery#1243 and sphinx-contrib/video#36.
These results are probably on the upper end, depending on if we change the bitrate, but disk usage is reduced substantially:
That's 108M of savings, or 22% of the original disk usage.
PR checklist