From f677c8038669b6ae5cedc736a0819d4dffd8b846 Mon Sep 17 00:00:00 2001 From: Jody Klymak Date: Sat, 6 Jul 2024 08:18:00 -0700 Subject: [PATCH] DOC: better cross referencing for animations --- doc/api/animation_api.rst | 3 +++ galleries/users_explain/animations/animations.py | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/api/animation_api.rst b/doc/api/animation_api.rst index df39b5942199..1233b482165d 100644 --- 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 index 0391d9bc030a..2711663196f2 100644 --- 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