mirror
/
linux
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
linux/Documentation/process
History
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
..
1.Intro.rst Doc: Correct typo, "Introdution" => "Introduction" 2016-12-01 10:44:08 -07:00
2.Process.rst
…
3.Early-stage.rst
…
4.Coding.rst docs-rst: doc-guide: split the kernel-documentation.rst contents 2016-11-19 10:22:04 -07:00
5.Posting.rst docs: fix locations of several documents that got moved 2016-10-24 08:12:35 -02:00
6.Followthrough.rst
…
7.AdvancedTopics.rst
…
8.Conclusion.rst docs: fix locations of several documents that got moved 2016-10-24 08:12:35 -02:00
adding-syscalls.rst docs: fix locations of several documents that got moved 2016-10-24 08:12:35 -02:00
applying-patches.rst docs: Add a warning to applying-patches.rst 2016-10-27 16:38:29 -06:00
changes.rst docs-rst: automatically convert Graphviz and SVG images 2017-03-09 02:59:26 -07:00
code-of-conflict.rst
…
coding-style.rst docs-rst: doc-guide: split the kernel-documentation.rst contents 2016-11-19 10:22:04 -07:00
conf.py
…
development-process.rst
…
email-clients.rst
…
howto.rst Documentation/process/howto: Only send regression fixes after -rc1 2016-11-28 17:24:32 -07:00
index.rst Merge branch 'doc-tweaks' into docs-next 2016-10-27 17:47:58 -06:00
kernel-docs.rst
…
magic-number.rst
…
management-style.rst docs: fix locations of several documents that got moved 2016-10-24 08:12:35 -02:00
stable-api-nonsense.rst
…
stable-kernel-rules.rst docs: fix locations of several documents that got moved 2016-10-24 08:12:35 -02:00
submit-checklist.rst docs: fix locations of several documents that got moved 2016-10-24 08:12:35 -02:00
submitting-drivers.rst docs: add a warning to submitting-drivers.rst 2016-10-27 16:38:06 -06:00
submitting-patches.rst docs: Tweak submitting-patches.rst formatting 2016-10-27 16:37:35 -06:00
volatile-considered-harmful.rst Documentation/atomic_ops.txt: convert to ReST markup 2016-11-30 17:40:52 -07:00