korg/linux
0
0
Fork 0
mirror of https://mirrors.bfsu.edu.cn/git/linux.git synced 2024-11-11 12:28:41 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs-rst: move Sphinx install instructions to sphinx.rst

Browse Source 
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 <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Mauro Carvalho Chehab 2017-07-14 13:41:17 -03:00 committed by Jonathan Corbet
parent 212fa2f84d
commit b8b07b5c8d
2 changed files with 19 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Documentation/doc-guide/sphinx.rst
View File

@ -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 ``Documentation``. Some of these will likely be converted to reStructuredText
over time, but the bulk of them will remain in plain text. 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 Sphinx Build
============ ============

14
Documentation/process/changes.rst
View File

@ -309,18 +309,8 @@ Kernel documentation
Sphinx Sphinx
------ ------
The ReST markups currently used by the Documentation/ files are meant to be Please see :ref:`sphinx_install` in ``Documentation/doc-guide/sphinx.rst``
built with ``Sphinx`` version 1.3 or upper. If you're desiring to build for details about Sphinx requirements.
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).
Getting updated software Getting updated software
======================== ========================