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?
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.
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’)
1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib-plantuml 0.8.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinxcontrib-plantuml-0.8.2.tar.gz | 6.1 kB | Details |
Release files / sphinxcontrib-plantuml-0.8.2.tar.gz
| Download URL | sphinxcontrib-plantuml-0.8.2.tar.gz |
|---|---|
| Size | 6.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
88e6995521ff5a567346c60c6ce580296ab2d67029a24353bb72ab6381cb2a96
|
|
BLAKE2b-256 checksum How to use checksums |
af222839812e7c9ebbc64f5b782ddc3c0046c28c7180919cb7f4fd7ea3933da4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
