aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSummer Qin <summer.qin@arm.com>2021-04-25 11:28:39 +0800
committerKen Liu <ken.liu@arm.com>2021-04-28 12:06:24 +0200
commitcd22d1bd7f96ece9f88df87445f7be138de380b3 (patch)
tree079b4ded7f070f0bf617f1e07099675f2cda3050
parentade2e0a3a339ae1c165cbe3bfe5171636ac798a7 (diff)
downloadtrusted-firmware-m-cd22d1bd7f96ece9f88df87445f7be138de380b3.tar.gz
Docs: Update description for Sphinx SVG plugin
Correct the description which is copied from plantuml, and update the missing information. Signed-off-by: Summer Qin <summer.qin@arm.com> Change-Id: Iaeecc0f481db1ef94e3a35920865e3dca467feda
-rw-r--r--docs/conf.py.in2
-rw-r--r--docs/getting_started/tfm_sw_requirement.rst5
2 files changed, 6 insertions, 1 deletions
diff --git a/docs/conf.py.in b/docs/conf.py.in
index 99b2fcb3e..b4430c98c 100644
--- a/docs/conf.py.in
+++ b/docs/conf.py.in
@@ -50,7 +50,7 @@ extensions = [
'm2r', #Support markdown files. Needed for external code.
'sphinx.ext.autosectionlabel', #Make sphinx generate a label for each section
'sphinxcontrib.plantuml', #Add support for PlantUML drawings
- 'sphinxcontrib.rsvgconverter' #Add support for PlantUML drawings
+ 'sphinxcontrib.rsvgconverter' #Add support for SVG to PDF
]
#Location of PlantUML
diff --git a/docs/getting_started/tfm_sw_requirement.rst b/docs/getting_started/tfm_sw_requirement.rst
index 4a30aa9be..f734105b7 100644
--- a/docs/getting_started/tfm_sw_requirement.rst
+++ b/docs/getting_started/tfm_sw_requirement.rst
@@ -283,6 +283,7 @@ The following additional tools are needed:
- Sphinx v1.7.9
- m2r v0.2.0
- sphinxcontrib-plantuml
+ - sphinxcontrib-svg2pdfconverter
- sphinx-rtd-theme
- Graphviz dot v2.38.0 or later
- PlantUML v1.2018.11 or later
@@ -382,6 +383,7 @@ To build the TF-M firmware the following tools are needed:
"Doxygen",">1.8","Reference manual"
"Sphinx",">1.4","User Guide"
"sphinxcontrib-plantuml",,"User Guide"
+ "sphinxcontrib-svg2pdfconverter",,"User Guide"
"sphinx-trd-theme",,"User Guide"
"Git",,
"PlantUML",">v1.2018.11","Reference Manual, User Guide"
@@ -411,6 +413,7 @@ Dependency chain:
state refman as "Reference Manual" <<doc>>
state rtd_theme as "sphinx-rtd-theme" <<doc>>
state sphnix_puml as "sphinxcontrib-plantuml" <<doc>>
+ state sphnix_svg as "sphinxcontrib-svg2pdfconverter" <<doc>>
state JRE as "JRE" <<doc>> : Java Runtime Environment
state gwiz as "Graphwiz dot" <<doc>>
state Sphinx as "Sphinx" <<doc>>
@@ -444,9 +447,11 @@ Dependency chain:
Sphinx --> m2r
Sphinx --> rtd_theme
Sphinx --> sphnix_puml
+ Sphinx --> sphnix_svg
m2r --> Python3
rtd_theme --> Python3
sphnix_puml --> Python3
+ sphnix_svg --> Python3
Sphinx --> PlantUML
PlantUML --> JRE
PlantUML --> gwiz