sphinx.rst: describe the install requirements for kfigure
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Fri, 14 Jul 2017 16:41:20 +0000 (13:41 -0300)
committerJonathan Corbet <corbet@lwn.net>
Mon, 17 Jul 2017 19:18:36 +0000 (13:18 -0600)
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>
Documentation/doc-guide/sphinx.rst

index 4c6cb454eaa05abb29e94a951e62225301938e7c..3a41483ed4991e14094392837ca7262290cc12bc 100644 (file)
@@ -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
+: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
 ============
 
@@ -278,6 +290,7 @@ Rendered as:
 
         - column 3
 
+.. _sphinx_kfigure:
 
 Figures & Images
 ================