Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit f14a44c

Browse files
anntzeranntzer
committed
Document animation HTML writer.
Just like all animation writers, it needs to be whitelisted in missing-references.json due to the way animation_api.rst uses autosummary.
1 parent 4412114 commit f14a44c

File tree

3 files changed

+78
-48
lines changed

3 files changed

+78
-48
lines changed

‎doc/api/animation_api.rst

Lines 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

Lines changed: 68 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -626,7 +626,7 @@
626626
"doc/api/prev_api_changes/api_changes_0.91.0.rst:34"
627627
],
628628
"matplotlib.pylab": [
629-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:624",
629+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:616",
630630
"doc/users/history.rst:63"
631631
],
632632
"matplotlib.tests.test_basic": [
@@ -666,12 +666,12 @@
666666
"lib/matplotlib/axes/_base.py:docstring of matplotlib.axes.Axes.update_datalim_bounds:2"
667667
],
668668
"Axes.fmt_xdata": [
669-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:405",
670-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:408"
669+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:397",
670+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:400"
671671
],
672672
"Axes.fmt_ydata": [
673-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:405",
674-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:408"
673+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:397",
674+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:400"
675675
],
676676
"Axes.transData": [
677677
"doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst:89",
@@ -684,14 +684,14 @@
684684
"lib/matplotlib/axes/_base.py:docstring of matplotlib.axes.Axes.add_child_axes:2"
685685
],
686686
"Axis._update_ticks": [
687-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:1074"
687+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:1066"
688688
],
689689
"Axis.get_inverted": [
690690
"doc/users/prev_whats_new/whats_new_3.1.0.rst:241",
691691
"doc/users/prev_whats_new/whats_new_3.1.0.rst:243"
692692
],
693693
"Axis.remove_overlaping_locs": [
694-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:79"
694+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:71"
695695
],
696696
"Axis.set_inverted": [
697697
"doc/users/prev_whats_new/whats_new_3.1.0.rst:241",
@@ -732,8 +732,8 @@
732732
"doc/devel/MEP/MEP23.rst:87"
733733
],
734734
"Formatter.__call__": [
735-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:1123",
736-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:1129"
735+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:1115",
736+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:1121"
737737
],
738738
"GaussianKDE": [
739739
"lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.violinplot:46",
@@ -752,7 +752,7 @@
752752
"lib/matplotlib/testing/decorators.py:docstring of matplotlib.testing.decorators.image_comparison:2"
753753
],
754754
"ImageComparisonTest": [
755-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:710"
755+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:702"
756756
],
757757
"Legend": [
758758
"doc/api/axes_api.rst:316:<autosummary>:1",
@@ -768,7 +768,7 @@
768768
"doc/api/prev_api_changes/api_changes_1.5.0.rst:119"
769769
],
770770
"MovieWriter.saving": [
771-
"doc/api/animation_api.rst:213"
771+
"doc/api/animation_api.rst:221"
772772
],
773773
"MovieWriterBase": [
774774
"lib/matplotlib/animation.py:docstring of matplotlib.animation.AVConvBase:4",
@@ -789,7 +789,7 @@
789789
"doc/devel/MEP/MEP23.rst:93"
790790
],
791791
"NavigationToolbar2QT.adj_window": [
792-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:969"
792+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:961"
793793
],
794794
"PolyCollection.get_offset": [
795795
"lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.hexbin:71",
@@ -899,19 +899,19 @@
899899
"doc/users/prev_whats_new/whats_new_3.0.rst:111"
900900
],
901901
"axes3d.Axes3D.xaxis": [
902-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:941"
902+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:933"
903903
],
904904
"axes3d.Axes3D.yaxis": [
905-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:941"
905+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:933"
906906
],
907907
"axes3d.Axes3D.zaxis": [
908-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:941"
908+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:933"
909909
],
910910
"axes_grid1": [
911911
"doc/index.rst:184"
912912
],
913913
"axis.Axis.get_ticks_position": [
914-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:829"
914+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:821"
915915
],
916916
"axisartist": [
917917
"doc/index.rst:184"
@@ -920,44 +920,44 @@
920920
"lib/matplotlib/backends/backend_template.py:docstring of matplotlib.backends.backend_template.RendererTemplate:4"
921921
],
922922
"backend_bases.Timer.add_callback": [
923-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:267"
923+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:259"
924924
],
925925
"backend_bases.Timer.remove_callback": [
926-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:247"
926+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:239"
927927
],
928928
"backend_bases.ToolContainerBase": [
929929
"lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.add_tools_to_container:8"
930930
],
931931
"backend_gtk3.FileChooserDialog": [
932-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:966"
932+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:958"
933933
],
934934
"backend_gtk3.NavigationToolbar2GTK3.get_filechooser": [
935-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:967"
935+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:959"
936936
],
937937
"backend_gtk3.SaveFigureGTK3.get_filechooser": [
938-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:968"
938+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:960"
939939
],
940940
"backend_wx.IDLE_DELAY": [
941-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:970"
941+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:962"
942942
],
943943
"barstacked": [
944944
"doc/users/prev_whats_new/whats_new_1.2.rst:177"
945945
],
946946
"bezier.check_if_parallel": [
947-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:801"
947+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:793"
948948
],
949949
"bezier.find_bezier_t_intersecting_with_closedpath": [
950-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:801"
950+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:793"
951951
],
952952
"bezier.find_r_to_boundary_of_closedpath": [
953-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:1026",
954-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:801"
953+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:1018",
954+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:793"
955955
],
956956
"bezier.split_bezier_intersecting_with_closedpath": [
957-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:801"
957+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:793"
958958
],
959959
"bezier.split_path_inout": [
960-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:801"
960+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:793"
961961
],
962962
"blocking_input.BlockingInput.__call__": [
963963
"doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst:293"
@@ -979,17 +979,20 @@
979979
"doc/devel/contributing.rst:521"
980980
],
981981
"cbook.deprecated": [
982-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:1081",
983-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:774"
982+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:1073",
983+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:766"
984984
],
985985
"cbook.warn_deprecated": [
986-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:774"
986+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:766"
987987
],
988988
"cbook.warn_deprecated()": [
989989
"doc/devel/contributing.rst:309"
990990
],
991+
"cleanup": [
992+
"lib/matplotlib/animation.py:docstring of matplotlib.animation.HTMLWriter.setup:19"
993+
],
991994
"collections.LineCollection.get_segements()": [
992-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:288"
995+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:280"
993996
],
994997
"colorbar.ColorbarBase.outline": [
995998
"doc/api/prev_api_changes/api_changes_1.4.x.rst:83"
@@ -998,10 +1001,10 @@
9981001
"lib/matplotlib/testing/compare.py:docstring of matplotlib.testing.compare.compare_images:4"
9991002
],
10001003
"dates.bytespdate2num": [
1001-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:927"
1004+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:919"
10021005
],
10031006
"dates.strpdate2num": [
1004-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:926"
1007+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:918"
10051008
],
10061009
"extend": [
10071010
"lib/matplotlib/colors.py:docstring of matplotlib.colors.from_levels_and_colors:13"
@@ -1101,7 +1104,7 @@
11011104
"doc/users/prev_whats_new/whats_new_2.0.0.rst:123"
11021105
],
11031106
"legend.Legend.set_draggable()": [
1104-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:507"
1107+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:499"
11051108
],
11061109
"levels": [
11071110
"doc/api/prev_api_changes/api_changes_3.0.0.rst:197"
@@ -1335,9 +1338,26 @@
13351338
"matplotlib.animation.FuncAnimation.to_jshtml": [
13361339
"lib/matplotlib/animation.py:docstring of matplotlib.animation.FuncAnimation.new_frame_seq:1:<autosummary>:1"
13371340
],
1338-
"matplotlib.animation.HTMLWriter": [
1339-
"doc/users/prev_whats_new/whats_new_2.1.0.rst:40",
1340-
"doc/users/prev_whats_new/whats_new_2.1.0.rst:51"
1341+
"matplotlib.animation.HTMLWriter.args_key": [
1342+
"lib/matplotlib/animation.py:docstring of matplotlib.animation.HTMLWriter.finish:1:<autosummary>:1"
1343+
],
1344+
"matplotlib.animation.HTMLWriter.bin_path": [
1345+
"doc/api/_as_gen/matplotlib.animation.HTMLWriter.rst:28:<autosummary>:1"
1346+
],
1347+
"matplotlib.animation.HTMLWriter.cleanup": [
1348+
"doc/api/_as_gen/matplotlib.animation.HTMLWriter.rst:28:<autosummary>:1"
1349+
],
1350+
"matplotlib.animation.HTMLWriter.exec_key": [
1351+
"lib/matplotlib/animation.py:docstring of matplotlib.animation.HTMLWriter.finish:1:<autosummary>:1"
1352+
],
1353+
"matplotlib.animation.HTMLWriter.frame_format": [
1354+
"lib/matplotlib/animation.py:docstring of matplotlib.animation.HTMLWriter.finish:1:<autosummary>:1"
1355+
],
1356+
"matplotlib.animation.HTMLWriter.frame_size": [
1357+
"lib/matplotlib/animation.py:docstring of matplotlib.animation.HTMLWriter.finish:1:<autosummary>:1"
1358+
],
1359+
"matplotlib.animation.HTMLWriter.saving": [
1360+
"doc/api/_as_gen/matplotlib.animation.HTMLWriter.rst:28:<autosummary>:1"
13411361
],
13421362
"matplotlib.animation.ImageMagickFileWriter.args_key": [
13431363
"lib/matplotlib/animation.py:docstring of matplotlib.animation.ImageMagickFileWriter.supported_formats:1:<autosummary>:1"
@@ -1446,13 +1466,13 @@
14461466
"doc/api/prev_api_changes/api_changes_1.5.0.rst:8"
14471467
],
14481468
"matplotlib.colorbar.ColorbarBase.set_clim": [
1449-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:298"
1469+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:290"
14501470
],
14511471
"matplotlib.colorbar.ColorbarBase.set_cmap": [
1452-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:298"
1472+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:290"
14531473
],
14541474
"matplotlib.colorbar.ColorbarBase.set_norm": [
1455-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:298"
1475+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:290"
14561476
],
14571477
"matplotlib.colors.same_color": [
14581478
"doc/users/prev_whats_new/whats_new_2.2.rst:218"
@@ -1473,10 +1493,10 @@
14731493
"doc/devel/documenting_mpl.rst:671"
14741494
],
14751495
"matplotlib.pylab": [
1476-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:626"
1496+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:618"
14771497
],
14781498
"matplotlib.pyplot.get_scale_docs()": [
1479-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:861"
1499+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:853"
14801500
],
14811501
"matplotlib.sphinxext.mathmpl": [
14821502
"doc/users/prev_whats_new/whats_new_3.0.rst:225"
@@ -1492,10 +1512,10 @@
14921512
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.rcdefaults:4"
14931513
],
14941514
"matplotlib.testing.compare.calculate_rms": [
1495-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:779"
1515+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:771"
14961516
],
14971517
"matplotlib.testing.conftest.mpl_test_settings": [
1498-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:949"
1518+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:941"
14991519
],
15001520
"move_canvas": [
15011521
"doc/devel/MEP/MEP23.rst:65"
@@ -1577,8 +1597,8 @@
15771597
"lib/matplotlib/dates.py:docstring of matplotlib.dates:105"
15781598
],
15791599
"scipy.stats.norm.pdf": [
1580-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:573",
1581-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:659"
1600+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:565",
1601+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:651"
15821602
],
15831603
"self.codes": [
15841604
"lib/matplotlib/path.py:docstring of matplotlib.path.Path.codes:2"
@@ -1631,7 +1651,7 @@
16311651
"doc/devel/MEP/MEP10.rst:170"
16321652
],
16331653
"streamplot.Grid": [
1634-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:487"
1654+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:479"
16351655
],
16361656
"strftime": [
16371657
"lib/matplotlib/dates.py:docstring of matplotlib.dates.ConciseDateFormatter:18"

‎lib/matplotlib/animation.py

Lines 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)