aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Hu <david.hu@arm.com>2021-07-08 22:09:16 +0800
committerDavid Hu <david.hu@arm.com>2021-07-13 10:16:12 +0200
commit828aa5712fa0cf4c4661afa53ef7b3bc53c7c390 (patch)
tree0b6b88ff04508243fa91ef9c5e05c9588171a78a
parent0e6b44e149c9b8de5990f0d942131699db1f47a7 (diff)
downloadtrusted-firmware-m-828aa5712fa0cf4c4661afa53ef7b3bc53c7c390.tar.gz
Docs: Add requirement of librsvg2-bin for doc generation
Require tool librsvg2-bin in docs for user guide generation. librsvg2-bin shall be installed to support sphinxcontrib-svg2pdfconverter. Otherwise, user guide build will throw out warnings that RSVG converter command 'rsvg-convert' cannot be run. Change-Id: Ic988b2771c0c5317b130bb37696c1c2833c162f7 Signed-off-by: David Hu <david.hu@arm.com>
-rw-r--r--docs/getting_started/tfm_getting_started.rst3
-rw-r--r--docs/technical_references/instructions/documentation_generation.rst2
2 files changed, 5 insertions, 0 deletions
diff --git a/docs/getting_started/tfm_getting_started.rst b/docs/getting_started/tfm_getting_started.rst
index 1fddbb0ae9..4e32ec3d1f 100644
--- a/docs/getting_started/tfm_getting_started.rst
+++ b/docs/getting_started/tfm_getting_started.rst
@@ -367,6 +367,7 @@ To build the TF-M firmware the following tools are needed:
"Java runtime environment (JRE)",">1.8","Reference Manual, User Guide"
"LaTex",,"pdf version of Reference Manual and User Guide"
"PdfLaTex",,"pdf version of Reference Manual and User Guide"
+ "librsvg2-bin",, "User Guide"
Dependency chain:
@@ -399,6 +400,7 @@ Dependency chain:
state LaTex as "LaTex" <<pdf>>
state PdfLaTex as "PdfLaTex" <<<<pdf>>>>
state Doxygen as "Doxygen" <<doc>>
+ state librsvg as "librsvg2-bin" <<doc>>
[*] --> fw
fw --> c_comp
@@ -431,6 +433,7 @@ Dependency chain:
tabs --> Python3
sphnix_puml --> Python3
sphnix_svg --> Python3
+ sphnix_svg --> librsvg
Sphinx --> PlantUML
PlantUML --> JRE
PlantUML --> gwiz
diff --git a/docs/technical_references/instructions/documentation_generation.rst b/docs/technical_references/instructions/documentation_generation.rst
index da21deed52..e6b4fc51ba 100644
--- a/docs/technical_references/instructions/documentation_generation.rst
+++ b/docs/technical_references/instructions/documentation_generation.rst
@@ -127,6 +127,8 @@ The following tools are needed:
- Java runtime environment 1.8 or later (for running PlantUML)
- LaTeX - for PDF generation only
- PdfLaTeX - for PDF generation only
+ - librsvg2-bin - a SVG pictures renderer library to support
+ sphinxcontrib-svg2pdfconverter
.. tabs::