diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-07-14 18:41:20 +0200 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2017-07-17 21:18:36 +0200 |
| commit | d43e5ae9748f327c60014973e3e290a6f02577ea (patch) | |
| tree | 42eb318049f002b111cdd011a9b9a79753210d9a /Documentation/doc-guide | |
| parent | sphinx.rst: fix unknown reference (diff) | |
| download | linux-d43e5ae9748f327c60014973e3e290a6f02577ea.tar.xz linux-d43e5ae9748f327c60014973e3e290a6f02577ea.zip | |
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.rst | 13 |
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. 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 ================ |