diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-07-14 18:41:21 +0200 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2017-07-17 21:18:42 +0200 |
commit | 6e322a17fbe574a1558abab10bb89205031ec921 (patch) | |
tree | 861a49f5f98464771b58ca5f862feba5e9c14917 | |
parent | sphinx.rst: describe the install requirements for kfigure (diff) | |
download | linux-6e322a17fbe574a1558abab10bb89205031ec921.tar.xz linux-6e322a17fbe574a1558abab10bb89205031ec921.zip |
sphinx.rst: better organize the documentation about PDF build
Instead of having it on just one note, add a separate section.
This way, we could later improve it, providing a better
guide about the needed steps for PDF builds.
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 | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst index 3a41483ed499..5521213efa68 100644 --- a/Documentation/doc-guide/sphinx.rst +++ b/Documentation/doc-guide/sphinx.rst @@ -60,14 +60,6 @@ in order to indicate that you're using the new environment. If you open a new shell, you need to rerun this command to enter again at the virtual environment before building the documentation. -.. 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). - Image output ------------ @@ -80,6 +72,19 @@ packages. If those packages are not installed, the build system will still build the documentation, but won't include any images at the output. +PDF and LaTeX builds +-------------------- + +Such builds are currently supported only with Sphinx versions 1.4 and 1.5. + +Currently, it is not possible to do pdf builds with Sphinx version 1.6. + +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. + Sphinx Build ============ |