Backport PR matplotlib#28517: DOC: better cross referencing for anima…

…tions
meeseeksmachine · Jul 7, 2024 · af6cc66 · af6cc66
1 parent 9c9792a
commit af6cc66
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/doc/api/animation_api.rst b/doc/api/animation_api.rst
@@ -18,6 +18,9 @@ Animation
 The easiest way to make a live animation in Matplotlib is to use one of the
 `Animation` classes.
 
+.. seealso::
+   - :ref:`animations`
+
 .. inheritance-diagram:: matplotlib.animation.FuncAnimation matplotlib.animation.ArtistAnimation
    :parts: 1
 

diff --git a/galleries/users_explain/animations/animations.py b/galleries/users_explain/animations/animations.py
@@ -11,7 +11,7 @@
 generate animations using the `~matplotlib.animation` module. An
 animation is a sequence of frames where each frame corresponds to a plot on a
 `~matplotlib.figure.Figure`. This tutorial covers a general guideline on
-how to create such animations and the different options available.
+how to create such animations and the different options available.  More information is available in the API description: `~matplotlib.animation`
 """
 
 import matplotlib.pyplot as plt