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.
1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib-plantuml 0.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.2.tar.gz | 3.9 kB | Details |
Release files / sphinxcontrib-plantuml-0.2.tar.gz
| Download URL | sphinxcontrib-plantuml-0.2.tar.gz |
|---|---|
| Size | 3.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
306ae9a564a5d6ef4232effa754c51cb09cdc239d4ba0199cacd1422087ea9e1
|
|
BLAKE2b-256 checksum How to use checksums |
03e8190a9884a664121f488fb73784c450f490b0c55865d20838513fa74fb5a6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
