sphinx.rst: describe the install requirements for kfigure

As we now have a document describing the install
requirements for Sphinx, add there the need for GraphViz
and ImageMagick.

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:20 -03:00 коммит произвёл Jonathan Corbet
Родитель 29fd35bd02
Коммит d43e5ae974
1 изменённых файлов: 13 добавлений и 0 удалений

Просмотреть файл

@ -68,6 +68,18 @@ the virtual environment before building the documentation.
functionalities required for ``XeLaTex`` to work. For PDF output you'll also functionalities required for ``XeLaTex`` to work. For PDF output you'll also
need ``convert(1)`` from ImageMagick (https://www.imagemagick.org). need ``convert(1)`` from ImageMagick (https://www.imagemagick.org).
Image output
------------
The kernel documentation build system contains an extension that
handles images on both GraphViz and SVG formats (see
:ref:`sphinx_kfigure`).
For it to work, you need to install both GraphViz and ImageMagick
packages. If those packages are not installed, the build system will
still build the documentation, but won't include any images at the
output.
Sphinx Build Sphinx Build
============ ============
@ -278,6 +290,7 @@ Rendered as:
- column 3 - column 3
.. _sphinx_kfigure:
Figures & Images Figures & Images
================ ================