Merge pull request #24897 from luke396/add-generate-ref-issue-24673

tacaswell · web-flow · commit 9a0b72a0c30d · 2023-01-09T12:31:29.000-05:00
DOC: Add ref for every example under examples/animation
diff --git a/examples/animation/animate_decay.py b/examples/animation/animate_decay.py
@@ -7,6 +7,8 @@
 
 - using a generator to drive an animation,
 - changing axes limits during an animation.
+
+Output generate via `matplotlib.animation.Animation.to_jshtml`.
 """
 
 import itertools
diff --git a/examples/animation/animated_histogram.py b/examples/animation/animated_histogram.py
@@ -45,6 +45,8 @@ def animate(frame_number):
 # ``prepare_animation`` will define ``animate`` function working with supplied
 # `.BarContainer`, all this is used to setup `.FuncAnimation`.
 
+# Output generate via `matplotlib.animation.Animation.to_jshtml`.
+
 fig, ax = plt.subplots()
 _, _, bar_container = ax.hist(data, HIST_BINS, lw=1,
                               ec="yellow", fc="green", alpha=0.5)
diff --git a/examples/animation/animation_demo.py b/examples/animation/animation_demo.py
@@ -10,6 +10,8 @@
 examples that use it.
 
 Note that calling `time.sleep` instead of `~.pyplot.pause` would *not* work.
+
+Output generate via `matplotlib.animation.Animation.to_jshtml`.
 """
 
 import matplotlib.pyplot as plt
diff --git a/examples/animation/bayes_update.py b/examples/animation/bayes_update.py
@@ -7,6 +7,8 @@
 new data arrives.
 The vertical line represents the theoretical value to which the plotted
 distribution should converge.
+
+Output generate via `matplotlib.animation.Animation.to_jshtml`.
 """
 
 import math
diff --git a/examples/animation/double_pendulum.py b/examples/animation/double_pendulum.py
@@ -7,6 +7,8 @@
 
 Double pendulum formula translated from the C code at
 http://www.physics.usyd.edu.au/~wheat/dpend_html/solve_dpend.c
+
+Output generate via `matplotlib.animation.Animation.to_jshtml`.
 """
 
 from numpy import sin, cos
diff --git a/examples/animation/dynamic_image.py b/examples/animation/dynamic_image.py
@@ -3,6 +3,7 @@
 Animated image using a precomputed list of images
 =================================================
 
+Output generate via `matplotlib.animation.Animation.to_jshtml`.
 """
 
 import numpy as np
diff --git a/examples/animation/frame_grabbing_sgskip.py b/examples/animation/frame_grabbing_sgskip.py
@@ -6,6 +6,8 @@
 Use a MovieWriter directly to grab individual frames and write them to a
 file.  This avoids any event loop integration, and thus works even with the Agg
 backend.  This is not recommended for use in an interactive setting.
+
+Output generate via `matplotlib.animation.Animation.to_jshtml`.
 """
 
 import numpy as np
diff --git a/examples/animation/multiple_axes.py b/examples/animation/multiple_axes.py
@@ -7,6 +7,8 @@
 
 - how animation across multiple subplots works,
 - using a figure artist in the animation.
+
+Output generate via `matplotlib.animation.Animation.to_jshtml`.
 """
 
 import numpy as np
diff --git a/examples/animation/pause_resume.py b/examples/animation/pause_resume.py
@@ -15,6 +15,8 @@
 
     You can copy and paste individual parts, or download the entire example
     using the link at the bottom of the page.
+
+Output generate via `matplotlib.animation.Animation.to_jshtml`.
 """
 
 import matplotlib.pyplot as plt
diff --git a/examples/animation/rain.py b/examples/animation/rain.py
@@ -7,6 +7,8 @@
 of 50 scatter points.
 
 Author: Nicolas P. Rougier
+
+Output generate via `matplotlib.animation.Animation.to_jshtml`.
 """
 
 import numpy as np
diff --git a/examples/animation/random_walk.py b/examples/animation/random_walk.py
@@ -3,6 +3,7 @@
 Animated 3D random walk
 =======================
 
+Output generate via `matplotlib.animation.Animation.to_jshtml`.
 """
 
 import numpy as np
diff --git a/examples/animation/simple_anim.py b/examples/animation/simple_anim.py
@@ -3,6 +3,7 @@
 Animated line plot
 ==================
 
+Output generate via `matplotlib.animation.Animation.to_jshtml`.
 """
 
 import numpy as np
diff --git a/examples/animation/simple_scatter.py b/examples/animation/simple_scatter.py
@@ -3,6 +3,7 @@
 Animated scatter saved as GIF
 =============================
 
+Output generate via `matplotlib.animation.Animation.to_jshtml`.
 """
 import numpy as np
 import matplotlib.pyplot as plt
diff --git a/examples/animation/strip_chart.py b/examples/animation/strip_chart.py
@@ -4,6 +4,8 @@
 ============
 
 Emulates an oscilloscope.
+
+Output generate via `matplotlib.animation.Animation.to_jshtml`.
 """
 
 import numpy as np
diff --git a/examples/animation/unchained.py b/examples/animation/unchained.py
@@ -7,6 +7,8 @@
 (mostly known because of the cover for Joy Division's Unknown Pleasures).
 
 Author: Nicolas P. Rougier
+
+Output generate via `matplotlib.animation.Animation.to_jshtml`.
 """
 
 import numpy as np
