File: PKG-INFO

package info (click to toggle)
python-sphinxcontrib.plantuml 0.5-5
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 148 kB
  • sloc: python: 279; makefile: 25
file content (95 lines) | stat: -rw-r--r-- 3,037 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
Metadata-Version: 1.1
Name: sphinxcontrib-plantuml
Version: 0.5
Summary: Sphinx "plantuml" extension
Home-page: https://bitbucket.org/birkenfeld/sphinx-contrib
Author: Yuya Nishihara
Author-email: yuya@tcha.org
License: BSD
Download-URL: https://pypi.python.org/pypi/sphinxcontrib-plantuml
Description: PlantUML for Sphinx
        ===================
        
        Usage
        -----
        
        Once you enable this extension,
        ::
        
            # Add any Sphinx extension module names here, as strings. They can be extensions
            # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
            extensions = ['sphinxcontrib.plantuml']
        
        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?
        
        You can specify ``height``, ``width`` or ``scale``::
        
            .. uml::
               :scale: 50 %
        
               Foo <|-- Bar
        
        You can specify a caption::
        
            .. uml::
               :caption: Caption with **bold** and *italic*
               :width: 50mm
        
               Foo <|-- Bar
        
        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 for HTML renderer. (default: 'png')
        
          :png: generate only .png
          :svg: generate .svg and .png as a fallback
        
        plantuml_latex_output_format
          Type of output image for LaTeX renderer. (default: 'png')
        
          :eps: generate .eps (not supported by `pdflatex`)
          :pdf: generate .eps and convert it to .pdf (requires `epstopdf`)
          :png: generate .png
        
          Because embedded png looks pretty bad, it is recommended to choose `pdf`
          for `pdflatex` or `eps` for `platex`.
        
        plantuml_epstopdf
          Path to epstopdf executable. (default: 'epstopdf')
        
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