Once you enable this extension, :
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinxcontrib.plantuml']
you may need to specify plantuml command in your conf.py:
plantuml = 'java -jar /path/to/plantuml.jar'
Instead, you can install a wrapper script in your PATH:
% cat <<EOT > /usr/local/bin/plantuml
#!/bin/sh -e
java -jar /path/to/plantuml.jar "$@"
EOT
% chmod +x /usr/local/bin/plantuml
Then, write PlantUML text under .. uml::
directive:
.. uml::
Alice -> Bob: Hi!
Alice <- Bob: How are you?
or specify path to external PlantUML file:
.. uml:: external.uml
You can specify height
, width
, scale
and align
:
.. uml::
:scale: 50 %
:align: center
Foo <|-- Bar
You can specify a caption:
.. uml::
:caption: Caption with **bold** and *italic*
:width: 50mm
Foo <|-- Bar
For details, please see PlantUML documentation.
- plantuml
Path to plantuml executable. (default: 'plantuml')
- plantuml_output_format
Type of output image for HTML renderer. (default: 'png')
- png
generate only .png
- svg
generate .svg and .png as a fallback
- none
do not generate any images (ignore uml directive)
- plantuml_latex_output_format
Type of output image for LaTeX renderer. (default: 'png')
- eps
generate .eps (not supported by pdflatex)
generate .eps and convert it to .pdf (requires epstopdf)
- png
generate .png
- none
do not generate any images (ignore uml directive)
Because embedded png looks pretty bad, it is recommended to choose pdf for pdflatex or eps for platex.
- plantuml_epstopdf
Path to epstopdf executable. (default: 'epstopdf')