diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2021-10-06 14:17:46 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-10-08 22:01:24 +0100 |
commit | bca3caeaeafc3c9c412ef33b1a9a3ef99b04baf1 (patch) | |
tree | feda1c56929d305c3ecc58c52a3c15c5caf6b5a5 /documentation/README | |
parent | 33ea53f00db5760650596af24d6c5bea262ed0f6 (diff) | |
download | poky-bca3caeaeafc3c9c412ef33b1a9a3ef99b04baf1.tar.gz |
Makefile: allow epub and latexpdf outputs to use diagrams from SVG sources
html output is great when directly using SVG
epub output has to use exported PNG because of issues using SVG directly
latexpdf output cannot use SVG, it needs exported PDF instead
This adds rules to generate PNG and PDF formats from new SVG sources.
Newly added diagrams have be stored in svg/ subdirectories
so that PNG and PDF files generated from SVG can be "gitignored"
without ignoring the original PNG diagrams that have no SVG source.
Note: had to remove the dependency to "Makefile" in the final "catch-all" target,
otherwise it was also catching the SVG to PNG and SVG to PDF targets.
(From yocto-docs rev: cd9bbd41d323bc124057396f142010509c65bbaf)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/README')
-rw-r--r-- | documentation/README | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/documentation/README b/documentation/README index 1e7b4f0e65..2d9eb887b2 100644 --- a/documentation/README +++ b/documentation/README | |||
@@ -113,6 +113,10 @@ To install all required packages run: | |||
113 | 113 | ||
114 | $ pip3 install sphinx sphinx_rtd_theme pyyaml | 114 | $ pip3 install sphinx sphinx_rtd_theme pyyaml |
115 | 115 | ||
116 | Also install the "inkscape" package from your distribution. | ||
117 | Inkscape is need to convert SVG graphics to PNG (for EPUB | ||
118 | export) and to PDF (for PDF export). | ||
119 | |||
116 | To build the documentation locally, run: | 120 | To build the documentation locally, run: |
117 | 121 | ||
118 | $ cd documentation | 122 | $ cd documentation |