[PATCH 5/6] sphinx.rst: describe the install requirements for kfigure

From: Mauro Carvalho Chehab
Date: Fri Jul 14 2017 - 07:08:51 EST

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@xxxxxxxxxxxxxxxx>
Documentation/doc-guide/sphinx.rst | 13 +++++++++++++
1 file changed, 13 insertions(+)

diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
index 4c6cb454eaa0..3a41483ed499 100644
--- a/Documentation/doc-guide/sphinx.rst
+++ b/Documentation/doc-guide/sphinx.rst
@@ -68,6 +68,18 @@ the virtual environment before building the documentation.
functionalities required for ``XeLaTex`` to work. For PDF output you'll also
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
+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
Sphinx Build

@@ -278,6 +290,7 @@ Rendered as:

- column 3

+.. _sphinx_kfigure:

Figures & Images