Metadata-Version: 2.1
Name: sphinxcontrib-kroki
Version: 1.2.1
Summary: Kroki integration into sphinx
Home-page: https://github.com/sphinx-contrib/kroki
Author: Martin Hasoň
Author-email: martin.hason@gmail.com
License: UNKNOWN
Description: sphinxcontrib-kroki
        ===================
        
        Embed PlantUML, DOT, etc. diagrams in your Sphinx-based documentation using
        [kroki](https://kroki.io/).
        
        Instalation
        -----------
        
        Install this package via pip:
        
        ```shell script
        pip install sphinxcontrib-kroki
        ```
        
        and enable in project configuration (`conf.py`):
        
        ```python
        extensions = [
            'sphinxcontrib.kroki',
        ]
        ```
        
        Usage
        -----
        
        Inline diagram, show as svg:
        
        ```rest
        .. kroki::
           :caption: Diagram
        
            @startuml
            Alice -> Bob: Authentication Request
            Bob --> Alice: Authentication Response
        
            Alice -> Bob: Another authentication Request
            Alice <-- Bob: Another authentication Response
            @enduml
        ```
        
        Load a diagram from a file and show as png:
        
        ```rest
        .. kroki:: ./path/to/graph.puml png
        ```
        
        ### Options
        
        - `:align:` The horizontal alignment of the diagram (left, center or right).
        - `:caption:` The caption of the diagram.
        - `:class:` The class names (a list of class names separeted by spaces).
        - `:filename:` The path to the file with the diagram.
        - `:format:` The output format of the diagram (default svg).
        - `:type:` The type of the diagram (blockdiag, bpmn, bytefield, seqdiag,
          actdiag, nwdiag, packetdiag, rackdiag, c4plantuml, ditaa, erd, excalidraw,
          graphviz, mermaid, nomnoml, plantuml, svgbob, umlet, vega, vegalite, wavedrom)
        
        The diagram type can be automatically derived from the file extension (as same as `type`).
        Additional supported extensions:
        
        Extension  | Type
        ---------- | ----
        *.bob      | svgbob
        *.c4       | c4plantuml
        *.c4puml   | c4plantuml
        *.dot      | graphviz
        *.er       | erd
        *.gv       | graphviz
        *.iuml     | plantuml
        *.pu       | plantuml
        *.puml     | plantuml
        *.uxf      | umlet
        *.vg       | vega
        *.vgl      | vegalite
        *.vl       | vegalite
        *.wsd      | plantuml
        
        Configuration
        -------------
        
        - `kroki_url` (default https://kroki.io).
        - `kroki_output_format` (default svg).
        - `kroki_inline_svg` (dafault False).
        
        Alternatives
        ------------
        
        - https://github.com/sphinx-contrib/plantuml
        - https://github.com/sphinx-contrib/gravizo
        - https://github.com/j-martin/sphinx-diagrams
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: code
Provides-Extra: test
Provides-Extra: extra
