Skip to content
This repository was archived by the owner on Jan 30, 2023. It is now read-only.

Commit ac83bdb

Browse files
committed
Proper hyperlink formatting in animate documentation.
1 parent 920c16e commit ac83bdb

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

src/sage/plot/animate.py

+16-11
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,16 @@
22
Animated plots
33
44
Animations are generated from a list (or other iterable) of graphics
5-
objects. Images are produced by calling the ``save_image`` method on
6-
each input object, and using ImageMagick's ``convert`` program [IM] or
7-
``ffmpeg`` [FF] to generate an animation. The output format is GIF by
8-
default, but can be any of the formats supported by ``convert`` or
9-
``ffmpeg``.
5+
objects.
6+
Images are produced by calling the ``save_image`` method on each input
7+
object, creating a sequence of PNG files.
8+
These are then assembled to various target formats using different
9+
tools.
10+
In particular, the ``convert`` program from ImageMagick_ can be used to
11+
generate an animated GIF file.
12+
FFmpeg_ (with the command line program ``ffmpeg``) provides support for
13+
various video formats, but also an alternative method of generating
14+
animated GIFs.
1015
1116
.. Warning::
1217
@@ -15,7 +20,8 @@
1520
convert`` at a command prompt to see if ``convert`` (part of the
1621
ImageMagick suite) is installed. If it is, you will be given its
1722
location. Similarly, you can check for ``ffmpeg`` with ``which
18-
ffmpeg``. See [IM] or [FF] for installation instructions.
23+
ffmpeg``. See the websites of ImageMagick_ or FFmpeg_ for
24+
installation instructions.
1925
2026
EXAMPLES:
2127
@@ -27,7 +33,7 @@
2733
Animation with 5 frames
2834
sage: a.show() # optional -- ImageMagick
2935
30-
Animate using ffmpeg instead of ImageMagick::
36+
Animate using FFmpeg_ instead of ImageMagick::
3137
3238
sage: f = sage.misc.temporary_file.tmp_filename(ext='.gif')
3339
sage: a.save(filename=f,use_ffmpeg=True) # optional -- ffmpeg
@@ -80,11 +86,10 @@
8086
- John Palmieri
8187
- Niles Johnson (2013-12): Expand to animate more graphics objects
8288
83-
REFERENCES:
89+
.. REFERENCES (not rendered as a section, but linked inline):
8490
85-
.. [IM] http://www.imagemagick.org
86-
87-
.. [FF] http://www.ffmpeg.org
91+
.. _ImageMagick: http://www.imagemagick.org
92+
.. _FFmpeg: http://www.ffmpeg.org
8893
8994
"""
9095

0 commit comments

Comments
 (0)