Description
sphinxcontrib-plantuml is a plantuml extension for Sphinx.
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.
User Reviews for sphinxcontrib-plantuml For Linux 1
-
for sphinxcontrib-plantuml For Linux
sphinxcontrib-plantuml: Great extension for Sphinx. Easy setup with helpful instructions. Enables clear diagrams in documentation. Recommended for users.