Commit c4f6bcf0 authored by Evan Read's avatar Evan Read Committed by Russell Dickenson

Use PlantUML intregration in PlantUML docs

parent 622f810e
...@@ -95,7 +95,7 @@ our AsciiDoc snippets, wikis and repos using delimited blocks: ...@@ -95,7 +95,7 @@ our AsciiDoc snippets, wikis and repos using delimited blocks:
~~~markdown ~~~markdown
```plantuml ```plantuml
Bob -> Alice : hello Bob -> Alice : hello
Alice -> Bob : Go Away Alice -> Bob : hi
``` ```
~~~ ~~~
...@@ -105,7 +105,7 @@ our AsciiDoc snippets, wikis and repos using delimited blocks: ...@@ -105,7 +105,7 @@ our AsciiDoc snippets, wikis and repos using delimited blocks:
[plantuml, format="png", id="myDiagram", width="200px"] [plantuml, format="png", id="myDiagram", width="200px"]
---- ----
Bob->Alice : hello Bob->Alice : hello
Alice -> Bob : Go Away Alice -> Bob : hi
---- ----
``` ```
...@@ -116,7 +116,7 @@ our AsciiDoc snippets, wikis and repos using delimited blocks: ...@@ -116,7 +116,7 @@ our AsciiDoc snippets, wikis and repos using delimited blocks:
:caption: Caption with **bold** and *italic* :caption: Caption with **bold** and *italic*
Bob -> Alice: hello Bob -> Alice: hello
Alice -> Bob: Go Away Alice -> Bob: hi
``` ```
You can also use the `uml::` directive for compatibility with [sphinxcontrib-plantuml](https://pypi.org/project/sphinxcontrib-plantuml/), but please note that we currently only support the `caption` option. You can also use the `uml::` directive for compatibility with [sphinxcontrib-plantuml](https://pypi.org/project/sphinxcontrib-plantuml/), but please note that we currently only support the `caption` option.
...@@ -125,7 +125,10 @@ The above blocks will be converted to an HTML img tag with source pointing to th ...@@ -125,7 +125,10 @@ The above blocks will be converted to an HTML img tag with source pointing to th
PlantUML instance. If the PlantUML server is correctly configured, this should PlantUML instance. If the PlantUML server is correctly configured, this should
render a nice diagram instead of the block: render a nice diagram instead of the block:
![PlantUML Integration](../img/integration/plantuml-example.png) ```plantuml
Bob -> Alice : hello
Alice -> Bob : hi
```
Inside the block you can add any of the supported diagrams by PlantUML such as Inside the block you can add any of the supported diagrams by PlantUML such as
[Sequence](http://plantuml.com/sequence-diagram), [Use Case](http://plantuml.com/use-case-diagram), [Sequence](http://plantuml.com/sequence-diagram), [Use Case](http://plantuml.com/use-case-diagram),
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment