Metadata-Version: 1.1
Name: sphinxcontrib-plantuml
Version: 0.2
Summary: Sphinx "plantuml" extension
Home-page: http://bitbucket.org/birkenfeld/sphinx-contrib
Author: Yuya Nishihara
Author-email: yuya@tcha.org
License: BSD
Download-URL: http://pypi.python.org/pypi/sphinxcontrib-plantuml
Description: PlantUML for Sphinx
        ===================
        
        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.
        
        .. _PlantUML: http://plantuml.sourceforge.net/
        
        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.
        
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
