Source

sphinx-contrib / plantuml /

Filename Size Date modified Message
..
sphinxcontrib
tests
49 B
1.5 KB
83 B
1.0 KB
864 B

PlantUML for Sphinx

Usage

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?

For details, please see PlantUML documentation.

Configuration

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
plantuml_latex_output_format

Type of output image for LaTeX renderer. (default: 'png')

eps:generate .eps (not supported by pdflatex)
pdf:generate .eps and convert it to .pdf (requires epstopdf)
png:generate .png

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')