Sphinx "PlantUML" extension
Project description
Usage
First, 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. (default: ‘png’)
- png:
generate only .png
- svg:
generate .svg and .png as a fallback
Currently this option is only supported by HTML renderer.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for sphinxcontrib-plantuml-0.2.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 306ae9a564a5d6ef4232effa754c51cb09cdc239d4ba0199cacd1422087ea9e1 |
|
| MD5 | 620c75163e4a829acaba103b76c7c164 |
|
| BLAKE2b-256 | 03e8190a9884a664121f488fb73784c450f490b0c55865d20838513fa74fb5a6 |
