Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1687564

[PATCH v2 5/6] sphinx.rst: describe the install requirements for kfigure

Show all headers | View raw

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

Back to linux.kernel | Previous | Next — Previous in thread | Next in thread | Find similar | Unroll thread

Thread

[PATCH v2 0/6] Better document Sphinx install instructions Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-07-14 18:50 +0200
  [PATCH v2 1/6] changes.rst: Update Sphinx minimal requirements Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-07-14 18:50 +0200
  [PATCH v2 5/6] sphinx.rst: describe the install requirements for kfigure Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-07-14 18:50 +0200
  [PATCH v2 3/6] sphinx.rst: explain the usage of virtual environment Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-07-14 18:50 +0200
  [PATCH v2 2/6] docs-rst: move Sphinx install instructions to sphinx.rst Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-07-14 18:50 +0200
  Re: [PATCH v2 0/6] Better document Sphinx install instructions Jonathan Corbet <corbet@lwn.net> - 2017-07-17 21:50 +0200
    Re: [PATCH v2 0/6] Better document Sphinx install instructions Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-07-17 23:30 +0200
      Re: [PATCH v2 0/6] Better document Sphinx install instructions Jonathan Corbet <corbet@lwn.net> - 2017-07-17 23:30 +0200
        Re: [PATCH v2 0/6] Better document Sphinx install instructions Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-07-18 00:00 +0200

csiph-web