diff options
| author | Paul Beesley <paul.beesley@arm.com> | 2019-07-12 11:56:58 +0100 |
|---|---|---|
| committer | Paul Beesley <paul.beesley@arm.com> | 2019-07-12 14:15:25 +0100 |
| commit | 7cb68807fbd2138bfc71ace3548e4366d15daacf (patch) | |
| tree | 2e22846d91a1de1eac0a7177cdf2430081576541 /docs/requirements.txt | |
| parent | 3ce3ce07385a6fe55018d825318a9aba2dab7289 (diff) | |
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>
Diffstat (limited to 'docs/requirements.txt')
| -rw-r--r-- | docs/requirements.txt | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/requirements.txt b/docs/requirements.txt index 8f95774b..358ed0e3 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,3 @@ sphinx>=2.0.0 -sphinx-rtd-theme>=0.4.3
\ No newline at end of file +sphinx-rtd-theme>=0.4.3 +sphinxcontrib-plantuml>=0.15 |