Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d43e5ae9 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files

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: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 29fd35bd

Documentation/doc-guide/sphinx.rst

+13 −0
Original line number Diff line number Diff line
@@ -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

================