Skip to content

Commit

Permalink
src/doc/en/installation/source.rst: Merge section on texlive etc. int…
Browse files Browse the repository at this point in the history
…o system package section
  • Loading branch information
Matthias Koeppe committed Jan 14, 2024
1 parent 6190102 commit 229cec0
Showing 1 changed file with 10 additions and 55 deletions.
65 changes: 10 additions & 55 deletions src/doc/en/installation/source.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,16 @@ install the following:

.. literalinclude:: void-develop.txt

For all users, we recommend that you install the following system packages,
which provide additional functionality and cannot be installed by Sage:
For all users, we recommend that you install the following system
packages, which provide additional functionality and cannot be
installed by Sage. In particular, this includes :wikipedia:`LaTeX
<LaTeX>` and related tools. In addition to a base install of :ref:`TeX
Live <spkg_texlive>`, our lists of system packages below include
everything that is needed for generating the Sage documentation in PDF
format. For converting Jupyter notebooks to PDF, also the document
converter :ref:`pandoc <spkg_pandoc>` is needed. For making
animations, Sage needs to use one of the packages :ref:`FFmpeg
<spkg_ffmpeg>` and :ref:`ImageMagick <spkg_imagemagick>`.

.. tab:: Debian/Ubuntu

Expand Down Expand Up @@ -1052,56 +1060,3 @@ a single copy of Sage in a multi-user computer network.
the installation by yourself::

$ sudo chown -R root SAGE_LOCAL


Additional software
-------------------

The following programs are not strictly required at build time or at run time,
but provide additional capabilities to Sage. We highly recommend a Sage user to
install them.

LaTeX
^^^^^

It is highly recommended that you have :wikipedia:`LaTeX <LaTeX>` installed,
but it is not required. The most popular packaging is `TeX Live
<https://www.tug.org/texlive/>`_, which can be installed following the
directions on their web site. On Linux systems you can alternatively install
your distribution's texlive packages::

$ sudo apt-get install texlive # debian
$ sudo yum install texlive # redhat

or similar commands. In addition to the base TeX Live install, you may
need some optional TeX Live packages, for example
country-specific Babel packages for the localized Sage
documentation.

Additionally, the following system packages are recommended on Debian/Ubuntu:

- ``texlive-generic-extra`` (to generate pdf documentation)

- ``texlive-xetex`` (to convert Jupyter notebooks to pdf)

- ``latexmk`` (to generate pdf documentation)

- ``dvipng`` (to render text with LaTeX in Matplotlib)

pandoc
^^^^^^

This is useful to convert Jupyter notebooks to pdf.

ffmpeg, ImageMagick
^^^^^^^^^^^^^^^^^^^

If you don't have either ImageMagick or ffmpeg, you won't be able to view
animations. ffmpeg can produce animations in more different formats than
ImageMagick, and seems to be faster than ImageMagick when creating animated
GIFs.

``libavdevice-dev`` is a component of ffmpeg to produce animations, and
recommended to install on Debian/Ubuntu.


0 comments on commit 229cec0

Please sign in to comment.