diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-07-14 12:41:17 -0400 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2017-07-17 15:18:18 -0400 |
commit | b8b07b5c8dfc1fdf2f93d7419e0cac1034abc937 (patch) | |
tree | 28ab69dbf767c2dbe1f2502f56b32135e83d77b7 | |
parent | 212fa2f84dbf36682ee6491f203471a27997043e (diff) |
docs-rst: move Sphinx install instructions to sphinx.rst
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>
-rw-r--r-- | Documentation/doc-guide/sphinx.rst | 17 | ||||
-rw-r--r-- | Documentation/process/changes.rst | 14 |
2 files changed, 19 insertions, 12 deletions
diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst index 84e8e8a9cbdb..1ee109b19322 100644 --- a/Documentation/doc-guide/sphinx.rst +++ b/Documentation/doc-guide/sphinx.rst | |||
@@ -19,6 +19,23 @@ Finally, there are thousands of plain text documentation files scattered around | |||
19 | ``Documentation``. Some of these will likely be converted to reStructuredText | 19 | ``Documentation``. Some of these will likely be converted to reStructuredText |
20 | over time, but the bulk of them will remain in plain text. | 20 | over time, but the bulk of them will remain in plain text. |
21 | 21 | ||
22 | .. _sphinx_install: | ||
23 | |||
24 | Sphinx Install | ||
25 | ============== | ||
26 | |||
27 | The ReST markups currently used by the Documentation/ files are meant to be | ||
28 | built with ``Sphinx`` version 1.3 or upper. If you're desiring to build | ||
29 | PDF outputs, it is recommended to use version 1.4.6 or upper. | ||
30 | |||
31 | .. note:: | ||
32 | |||
33 | Please notice that, for PDF and LaTeX output, you'll also need ``XeLaTeX`` | ||
34 | version 3.14159265. Depending on the distribution, you may also need to | ||
35 | install a series of ``texlive`` packages that provide the minimal set of | ||
36 | functionalities required for ``XeLaTex`` to work. For PDF output you'll also | ||
37 | need ``convert(1)`` from ImageMagick (https://www.imagemagick.org). | ||
38 | |||
22 | Sphinx Build | 39 | Sphinx Build |
23 | ============ | 40 | ============ |
24 | 41 | ||
diff --git a/Documentation/process/changes.rst b/Documentation/process/changes.rst index ceddf1d1e646..560beaef5a7c 100644 --- a/Documentation/process/changes.rst +++ b/Documentation/process/changes.rst | |||
@@ -309,18 +309,8 @@ Kernel documentation | |||
309 | Sphinx | 309 | Sphinx |
310 | ------ | 310 | ------ |
311 | 311 | ||
312 | The ReST markups currently used by the Documentation/ files are meant to be | 312 | Please see :ref:`sphinx_install` in ``Documentation/doc-guide/sphinx.rst`` |
313 | built with ``Sphinx`` version 1.3 or upper. If you're desiring to build | 313 | for details about Sphinx requirements. |
314 | PDF outputs, it is recommended to use version 1.4.6 or upper. | ||
315 | |||
316 | .. note:: | ||
317 | |||
318 | Please notice that, for PDF and LaTeX output, you'll also need ``XeLaTeX`` | ||
319 | version 3.14159265. Depending on the distribution, you may also need to | ||
320 | install a series of ``texlive`` packages that provide the minimal set of | ||
321 | functionalities required for ``XeLaTex`` to work. For PDF output you'll also | ||
322 | need ``convert(1)`` from ImageMagick (https://www.imagemagick.org). | ||
323 | |||
324 | 314 | ||
325 | Getting updated software | 315 | Getting updated software |
326 | ======================== | 316 | ======================== |