aboutsummaryrefslogtreecommitdiff
path: root/Documentation/sphinx/kfigure.py
AgeCommit message (Collapse)AuthorFilesLines
2020-06-08Replace HTTP links with HTTPS ones: documentationAlexander A. Klimov1-3/+3
Rationale: Reduces attack surface on kernel devs opening the links for MITM as HTTPS traffic is much harder to manipulate. Deterministic algorithm: For each file: For each line: If doesn't contain `\bxmlns\b`: For each link, `\bhttp://[^# \t\r\n]*(?:\w|/)`: If both the HTTP and HTTPS versions return 200 OK and serve the same content: Replace HTTP with HTTPS. Signed-off-by: Alexander A. Klimov <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2019-05-23doc: Cope with Sphinx logging deprecationsJonathan Corbet1-17/+23
Recent versions of sphinx will emit messages like: Documentation/sphinx/kerneldoc.py:103: RemovedInSphinx20Warning: app.warning() is now deprecated. Use sphinx.util.logging instead. Switch to sphinx.util.logging to make this unsightly message go away. Alas, that interface was only added in version 1.6, so we have to add a version check to keep things working with older sphinxes. Cc: [email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2018-01-17linux-next: docs-rst: Fix typos in kfigure.pyMasanari Iida1-3/+3
This patch fixes some spelling typos found in kfigure.py Signed-off-by: Masanari Iida <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2017-03-09docs-rst: automatically convert Graphviz and SVG imagesMarkus Heiser1-0/+551
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 <[email protected]> Cc: Laurent Pinchart <[email protected]> Tested-by: Mauro Carvalho Chehab <[email protected]> Tested-by: Daniel Vetter <[email protected]> Signed-off-by: Daniel Vetter <[email protected]> (v2 - v5) Signed-off-by: Markus Heiser <[email protected]> (v1, v6) Signed-off-by: Jonathan Corbet <[email protected]>