summaryrefslogtreecommitdiff
path: root/docs/conf.py
diff options
context:
space:
mode:
authorPaul Beesley <paul.beesley@arm.com>2019-07-12 11:56:58 +0100
committerPaul Beesley <paul.beesley@arm.com>2019-07-12 14:15:25 +0100
commit7cb68807fbd2138bfc71ace3548e4366d15daacf (patch)
tree2e22846d91a1de1eac0a7177cdf2430081576541 /docs/conf.py
parent3ce3ce07385a6fe55018d825318a9aba2dab7289 (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/conf.py')
-rw-r--r--docs/conf.py8
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 64f12431..b267de0e 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -23,7 +23,7 @@ release = version # We don't need these to be distinct
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
-extensions = ['sphinx.ext.autosectionlabel']
+extensions = ['sphinx.ext.autosectionlabel', 'sphinxcontrib.plantuml']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -82,4 +82,8 @@ html_theme_options = {
# -- Options for autosectionlabel --------------------------------------------
# Only generate automatic section labels for document titles
-autosectionlabel_maxdepth = 1 \ No newline at end of file
+autosectionlabel_maxdepth = 1
+
+# -- Options for plantuml ----------------------------------------------------
+
+plantuml_output_format = 'svg_img'