linux/Documentation/doc-guide
Markus Heiser db6ccf23e8 docs-rst: automatically convert Graphviz and SVG images
This patch brings scalable figure, image handling and a concept to
embed *render* markups:

* DOT (http://www.graphviz.org)
* SVG

For image handling use the 'image' replacement::

    .. kernel-image::  svg_image.svg
       :alt:    simple SVG image

For figure handling use the 'figure' replacement::

    .. kernel-figure::  svg_image.svg
       :alt:    simple SVG image

       SVG image example

Embed *render* markups (or languages) like Graphviz's **DOT** is
provided by the *render* directive.::

  .. kernel-render:: DOT
     :alt: foobar digraph
     :caption: Embedded **DOT** (Graphviz) code.

     digraph foo {
      "bar" -> "baz";
     }

The *render* directive is a concept to integrate *render* markups and
languages, yet supported markups:

* DOT: render embedded Graphviz's **DOT**
* SVG: render embedded Scalable Vector Graphics (**SVG**)

Cc: Jani Nikula <jani.nikula@linux.intel.com>
Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Tested-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Tested-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com> (v2 - v5)
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> (v1, v6)
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2017-03-09 02:59:26 -07:00
..
conf.py
docbook.rst
hello.dot docs-rst: automatically convert Graphviz and SVG images 2017-03-09 02:59:26 -07:00
index.rst parse-headers.pl: add documentation for this script 2016-11-19 10:22:08 -07:00
kernel-doc.rst Merge branch 'mauro-doc' into docs-next 2016-11-19 10:28:58 -07:00
parse-headers.rst docs-rst: parse-headers.pl: cleanup the documentation 2016-11-30 17:08:09 -07:00
sphinx.rst docs-rst: automatically convert Graphviz and SVG images 2017-03-09 02:59:26 -07:00
svg_image.svg docs-rst: automatically convert Graphviz and SVG images 2017-03-09 02:59:26 -07:00