{"categories":[{"label":"Utilities","url":"https://skillfed.io/packages/category/utilities/5"},{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation"}],"enrichment":{"capability":"Adds PlantUML diagram rendering to Sphinx documentation, letting you embed UML diagrams directly in reStructuredText source files and generate them as PNG, SVG, or PDF during builds.","skillfed_tags":["sphinx-extension","uml-diagrams","documentation-generation"],"use_cases":["Embed sequence diagrams, class hierarchies, and state machines directly in API or architecture documentation without maintaining separate image files.","Generate consistent UML diagrams in both HTML and PDF versions of the same documentation from a single source.","Document system design and component relationships in technical specifications alongside prose, keeping diagrams version-controlled with source.","Reduce friction when updating diagrams by editing text in the documentation source rather than using a GUI tool and committing binary files."],"what_it_does":"sphinxcontrib-plantuml is a Sphinx extension that lets you write PlantUML diagrams inline in reStructuredText using the ``.. uml::`` directive, then automatically renders them as images during documentation builds. It depends on Sphinx and requires a working PlantUML installation (typically a Java JAR file) on your build system.\n\nThe extension supports multiple output formats\u2014PNG, SVG, and PDF\u2014and can generate different formats for HTML and LaTeX output. You configure it via Sphinx's conf.py, specifying the PlantUML executable path and output format preferences. It includes caching to avoid re-rendering unchanged diagrams and an experimental batch mode to reduce Java startup overhead when rendering many diagrams.","worth_installing":"Yes, if you already use Sphinx and have Java and PlantUML available on your build system. The extension is stable (Beta status, 133 GitHub stars, no known vulnerabilities) and widely used (top 15000 PyPI packages). High install friction is the main trade-off: you must set up PlantUML separately, and aging maintenance (last release 345 days ago) means updates may lag behind Sphinx releases, so test compatibility with your Sphinx version before deploying."},"id":"sphinxcontrib-plantuml","links":{"html":"https://skillfed.io/packages/sphinxcontrib-plantuml","md":"https://skillfed.io/packages/sphinxcontrib-plantuml.md","pypi":"https://pypi.org/project/sphinxcontrib-plantuml/"},"maintenance":{"status":"aging"},"meta":{"latest_release":"2025-09-03","license_spdx":null,"license_treatment":"permissive","name":"sphinxcontrib-plantuml","python_support":"unspecified","summary":"Sphinx \"plantuml\" extension"},"popularity":{"monthly_downloads":600936,"position":5819,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.31"}