lkml.org 
[lkml]   [2017]   [Jul]   [14]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH v2 5/6] sphinx.rst: describe the install requirements for kfigure
    Date
    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>
    ---
    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
    +: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
    ================
    --
    2.13.0
    \
     
     \ /
      Last update: 2017-07-14 18:43    [W:3.365 / U:0.204 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site