doc: Generate PlantUML diagrams automatically
authorPaul Beesley <paul.beesley@arm.com>
Fri, 12 Jul 2019 10:56:58 +0000 (11:56 +0100)
committerPaul Beesley <paul.beesley@arm.com>
Fri, 12 Jul 2019 13:15:25 +0000 (14:15 +0100)
commit7cb68807fbd2138bfc71ace3548e4366d15daacf
tree2e22846d91a1de1eac0a7177cdf2430081576541
parent3ce3ce07385a6fe55018d825318a9aba2dab7289
doc: Generate PlantUML diagrams automatically

Currently we have some pre-rendered versions of certain diagrams
in SVG format. These diagrams have corresponding PlantUML source
that can be rendered automatically as part of the documentation
build, removing the need for any intermediate files.

This patch adds the Sphinx "plantuml" extension, replaces
references to the pre-rendered SVG files within the documents,
and finally removes the SVG files and helper script.

New requirements for building the docs are the
"sphinxcontrib-plantuml" Python module (added to the pip
requirements.txt file) and the Graphviz package (provides the
"dot" binary) which is in the Ubuntu package repositories.

Change-Id: I24b52ee40ff79676212ed7cff350294945f1b50d
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
docs/components/sdei.rst
docs/conf.py
docs/requirements.txt
docs/resources/diagrams/plantuml/plantuml_to_svg.sh [deleted file]
docs/resources/diagrams/plantuml/sdei_explicit_dispatch.svg [deleted file]
docs/resources/diagrams/plantuml/sdei_general.svg [deleted file]