Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit d500923

Browse filesBrowse files
authored
Merge pull request #16333 from anntzer/htmlw
Document animation HTML writer.
2 parents c58ca60 + d29b3d1 commit d500923
Copy full SHA for d500923

File tree

Expand file treeCollapse file tree

3 files changed

+35
-5
lines changed
Filter options
Expand file treeCollapse file tree

3 files changed

+35
-5
lines changed

‎doc/api/animation_api.rst

Copy file name to clipboardExpand all lines: doc/api/animation_api.rst
+8Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,14 @@ all data in memory.
168168

169169
PillowWriter
170170

171+
The HTML writer generates JavaScript-based animations.
172+
173+
.. autosummary::
174+
:toctree: _as_gen
175+
:nosignatures:
176+
177+
HTMLWriter
178+
171179
The pipe-based writers stream the captured frames over a pipe to an external
172180
process. The pipe-based variants tend to be more performant, but may not work
173181
on all systems.

‎doc/missing-references.json

Copy file name to clipboardExpand all lines: doc/missing-references.json
+25-5Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -752,7 +752,7 @@
752752
"doc/api/prev_api_changes/api_changes_1.5.0.rst:119"
753753
],
754754
"MovieWriter.saving": [
755-
"doc/api/animation_api.rst:213"
755+
"doc/api/animation_api.rst:221"
756756
],
757757
"MovieWriterBase": [
758758
"lib/matplotlib/animation.py:docstring of matplotlib.animation.AVConvBase:4",
@@ -972,6 +972,9 @@
972972
"cbook.warn_deprecated()": [
973973
"doc/devel/contributing.rst:309"
974974
],
975+
"cleanup": [
976+
"lib/matplotlib/animation.py:docstring of matplotlib.animation.HTMLWriter.setup:19"
977+
],
975978
"collections.LineCollection.get_segements()": [
976979
"doc/api/prev_api_changes/api_changes_3.1.0.rst:280"
977980
],
@@ -1316,9 +1319,26 @@
13161319
"matplotlib.animation.FuncAnimation.to_jshtml": [
13171320
"lib/matplotlib/animation.py:docstring of matplotlib.animation.FuncAnimation.new_frame_seq:1:<autosummary>:1"
13181321
],
1319-
"matplotlib.animation.HTMLWriter": [
1320-
"doc/users/prev_whats_new/whats_new_2.1.0.rst:40",
1321-
"doc/users/prev_whats_new/whats_new_2.1.0.rst:51"
1322+
"matplotlib.animation.HTMLWriter.args_key": [
1323+
"lib/matplotlib/animation.py:docstring of matplotlib.animation.HTMLWriter.finish:1:<autosummary>:1"
1324+
],
1325+
"matplotlib.animation.HTMLWriter.bin_path": [
1326+
"doc/api/_as_gen/matplotlib.animation.HTMLWriter.rst:28:<autosummary>:1"
1327+
],
1328+
"matplotlib.animation.HTMLWriter.cleanup": [
1329+
"doc/api/_as_gen/matplotlib.animation.HTMLWriter.rst:28:<autosummary>:1"
1330+
],
1331+
"matplotlib.animation.HTMLWriter.exec_key": [
1332+
"lib/matplotlib/animation.py:docstring of matplotlib.animation.HTMLWriter.finish:1:<autosummary>:1"
1333+
],
1334+
"matplotlib.animation.HTMLWriter.frame_format": [
1335+
"lib/matplotlib/animation.py:docstring of matplotlib.animation.HTMLWriter.finish:1:<autosummary>:1"
1336+
],
1337+
"matplotlib.animation.HTMLWriter.frame_size": [
1338+
"lib/matplotlib/animation.py:docstring of matplotlib.animation.HTMLWriter.finish:1:<autosummary>:1"
1339+
],
1340+
"matplotlib.animation.HTMLWriter.saving": [
1341+
"doc/api/_as_gen/matplotlib.animation.HTMLWriter.rst:28:<autosummary>:1"
13221342
],
13231343
"matplotlib.animation.ImageMagickFileWriter.args_key": [
13241344
"lib/matplotlib/animation.py:docstring of matplotlib.animation.ImageMagickFileWriter.supported_formats:1:<autosummary>:1"
@@ -1669,4 +1689,4 @@
16691689
"lib/mpl_toolkits/mplot3d/axes3d.py:docstring of mpl_toolkits.mplot3d.axes3d.Axes3D.get_ylim3d:24"
16701690
]
16711691
}
1672-
}
1692+
}

‎lib/matplotlib/animation.py

Copy file name to clipboardExpand all lines: lib/matplotlib/animation.py
+2Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -777,6 +777,8 @@ def _embedded_frames(frame_list, frame_format):
777777

778778
@writers.register('html')
779779
class HTMLWriter(FileMovieWriter):
780+
"""Writer for JavaScript-based HTML movies."""
781+
780782
supported_formats = ['png', 'jpeg', 'tiff', 'svg']
781783
_args_key = 'animation.html_args'
782784

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.