summaryrefslogtreecommitdiffstats
path: root/Documentation/doc-guide
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2017-07-14 12:41:20 -0400
committerJonathan Corbet <corbet@lwn.net>2017-07-17 15:18:36 -0400
commitd43e5ae9748f327c60014973e3e290a6f02577ea (patch)
tree42eb318049f002b111cdd011a9b9a79753210d9a /Documentation/doc-guide
parent29fd35bd02568f27b463657218889276215b1662 (diff)
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>
Diffstat (limited to 'Documentation/doc-guide')
-rw-r--r--Documentation/doc-guide/sphinx.rst13
1 files changed, 13 insertions, 0 deletions
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.
68 functionalities required for ``XeLaTex`` to work. For PDF output you'll also 68 functionalities required for ``XeLaTex`` to work. For PDF output you'll also
69 need ``convert(1)`` from ImageMagick (https://www.imagemagick.org). 69 need ``convert(1)`` from ImageMagick (https://www.imagemagick.org).
70 70
71Image output
72------------
73
74The kernel documentation build system contains an extension that
75handles images on both GraphViz and SVG formats (see
76:ref:`sphinx_kfigure`).
77
78For it to work, you need to install both GraphViz and ImageMagick
79packages. If those packages are not installed, the build system will
80still build the documentation, but won't include any images at the
81output.
82
71Sphinx Build 83Sphinx Build
72============ 84============
73 85
@@ -278,6 +290,7 @@ Rendered as:
278 290
279 - column 3 291 - column 3
280 292
293.. _sphinx_kfigure:
281 294
282Figures & Images 295Figures & Images
283================ 296================