DOC: Add links to supported file formats in animations tutorial

StefRe · StefRe · commit 7afff7f9170e · 2022-11-29T10:39:03.000+01:00
for ffmpeg and imagemagick. Remove last paragraph as it became
redundant (see section Animation Writers).
diff --git a/.flake8 b/.flake8
@@ -82,6 +82,7 @@ per-file-ignores =
     tutorials/introductory/pyplot.py: E402, E501
     tutorials/introductory/sample_plots.py: E501
     tutorials/introductory/quick_start.py: E703
+    tutorials/introductory/animation_tutorial.py: E501
     tutorials/text/annotations.py: E402, E501
     tutorials/text/text_intro.py: E402
     tutorials/text/text_props.py: E501
diff --git a/tutorials/introductory/animation_tutorial.py b/tutorials/introductory/animation_tutorial.py
@@ -175,15 +175,27 @@ def update(frame):
 # Saving Animations
 # -----------------
 #
-# ========================================== ===========================
-# Writer                                     Supported Formats
-# ========================================== ===========================
-# `~matplotlib.animation.PillowWriter`       .gif, .apng, .webp
-# `~matplotlib.animation.HTMLWriter`         .htm, .html, .png
-# `~matplotlib.animation.FFMpegWriter`       All formats supported by *ffmpeg*
-# `~matplotlib.animation.ImageMagickWriter`  All formats supported by
-#                                            *imagemagick*
-# ========================================== ===========================
+# .. list-table::
+#    :header-rows: 1
+#
+#    * - Writer
+#      - Supported Formats
+#    * - `~matplotlib.animation.PillowWriter`
+#      - .gif, .apng, .webp
+#    * - `~matplotlib.animation.HTMLWriter`
+#      - .htm, .html, .png
+#    * - | `~matplotlib.animation.FFMpegWriter`
+#        | `~matplotlib.animation.FFMpegFileWriter`
+#      - All formats supported by |ffmpeg|_: ``ffmpeg -formats``
+#    * - | `~matplotlib.animation.ImageMagickWriter`
+#        | `~matplotlib.animation.ImageMagickFileWriter`
+#      - All formats supported by |imagemagick|_: ``magick -list format``
+#
+# .. _ffmpeg: https://www.ffmpeg.org/general.html#Supported-File-Formats_002c-Codecs-or-Features
+# .. |ffmpeg| replace:: *ffmpeg*
+#
+# .. _imagemagick: https://imagemagick.org/script/formats.php#supported
+# .. |imagemagick| replace:: *imagemagick*
 #
 # To save animations using any of the writers, we can use the
 # `.animation.Animation.save` method. It takes the *filename* that we want to
@@ -222,8 +234,4 @@ def update(frame):
 #   ani.save(filename="apng:/tmp/imagemagick_example.apng",
 #            writer="imagemagick", extra_args=["-quality", "100"])
 #
-# (the ``extra_args`` for apng are needed to reduce filesize by ~10x)
-#
-# Since the frames are piped out to *ffmpeg* or *imagemagick*,
-# ``writer="ffmpeg"`` and ``writer="imagemagick"`` support all formats
-# supported by *ffmpeg* and *imagemagick*.
+# (the ``extra_args`` for *apng* are needed to reduce filesize by ~10x)
