Skip to content

Commit

Permalink
docs-rst: move Sphinx install instructions to sphinx.rst
Browse files Browse the repository at this point in the history
The toolchain used by Sphinx is somewhat complex, and installing
it should be part of the doc-guide.

Move it out of changes.rst.

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
  • Loading branch information
mchehab authored and Jonathan Corbet committed Jul 17, 2017
1 parent 212fa2f commit b8b07b5
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 12 deletions.
17 changes: 17 additions & 0 deletions Documentation/doc-guide/sphinx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,23 @@ Finally, there are thousands of plain text documentation files scattered around
``Documentation``. Some of these will likely be converted to reStructuredText
over time, but the bulk of them will remain in plain text.

.. _sphinx_install:

Sphinx Install
==============

The ReST markups currently used by the Documentation/ files are meant to be
built with ``Sphinx`` version 1.3 or upper. If you're desiring to build
PDF outputs, it is recommended to use version 1.4.6 or upper.

.. note::

Please notice that, for PDF and LaTeX output, you'll also need ``XeLaTeX``
version 3.14159265. Depending on the distribution, you may also need to
install a series of ``texlive`` packages that provide the minimal set of
functionalities required for ``XeLaTex`` to work. For PDF output you'll also
need ``convert(1)`` from ImageMagick (https://www.imagemagick.org).

Sphinx Build
============

Expand Down
14 changes: 2 additions & 12 deletions Documentation/process/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -309,18 +309,8 @@ Kernel documentation
Sphinx
------

The ReST markups currently used by the Documentation/ files are meant to be
built with ``Sphinx`` version 1.3 or upper. If you're desiring to build
PDF outputs, it is recommended to use version 1.4.6 or upper.

.. note::

Please notice that, for PDF and LaTeX output, you'll also need ``XeLaTeX``
version 3.14159265. Depending on the distribution, you may also need to
install a series of ``texlive`` packages that provide the minimal set of
functionalities required for ``XeLaTex`` to work. For PDF output you'll also
need ``convert(1)`` from ImageMagick (https://www.imagemagick.org).

Please see :ref:`sphinx_install` in ``Documentation/doc-guide/sphinx.rst``
for details about Sphinx requirements.

Getting updated software
========================
Expand Down

0 comments on commit b8b07b5

Please sign in to comment.