{"author":"Yuya Nishihara","author_email":"yuya@tcha.org","bugtrack_url":null,"classifiers":["Development Status :: 4 - Beta","Environment :: Console","Environment :: Web Environment","Framework :: Sphinx :: Extension","Intended Audience :: Developers","License :: OSI Approved :: BSD License","Operating System :: OS Independent","Programming Language :: Python","Topic :: Documentation","Topic :: Utilities"],"description":"PlantUML for Sphinx\n===================\n\nInstallation\n------------\n\n.. code-block::\n\n pip install sphinxcontrib-plantuml\n\nUsage\n-----\n\nAdd ``sphinxcontrib.plantuml`` to your extensions list in your ``conf.py``:\n\n\n.. code-block:: python\n\n extensions = [\n 'sphinxcontrib.plantuml',\n ]\n\nYou may also need to specify the plantuml command in your **conf.py**:\n\n.. code-block:: python\n\n plantuml = 'java -jar /path/to/plantuml.jar'\n\nInstead, you can install a wrapper script in your PATH:\n\n.. code-block:: console\n\n % cat < /usr/local/bin/plantuml\n #!/bin/sh -e\n java -jar /path/to/plantuml.jar \"$@\"\n EOT\n % chmod +x /usr/local/bin/plantuml\n\nThen, write PlantUML text under the ``.. uml::`` (or ``.. plantuml::``)\ndirective::\n\n .. uml::\n\n Alice -> Bob: Hi!\n Alice <- Bob: How are you?\n\nor specify path to an external PlantUML file::\n\n .. uml:: external.uml\n\nYou can specify ``height``, ``width``, ``scale`` and ``align``::\n\n .. uml::\n :scale: 50 %\n :align: center\n\n Foo <|-- Bar\n\nYou can also specify a caption::\n\n .. uml::\n :caption: Caption with **bold** and *italic*\n :width: 50mm\n\n Foo <|-- Bar\n\nFor details, please see PlantUML_ documentation.\n\n.. _PlantUML: http://plantuml.com/\n\nConfiguration\n-------------\n\nplantuml\n Path to plantuml executable. (default: 'plantuml')\n\nplantuml_output_format\n Type of output image for HTML renderer. (default: 'png')\n\n :png: generate only .png inside \n :svg: generate .svg inside

Package search

sphinxcontrib-plantuml

project_urls

Dependencies

All package metadata

Releases