summaryrefslogtreecommitdiff
path: root/doc/administration/integration
diff options
context:
space:
mode:
authorRémy Coutable <remy@rymai.me>2017-09-07 14:45:03 +0000
committerRémy Coutable <remy@rymai.me>2017-09-07 14:45:03 +0000
commit4bb1a3c159860083860a41c738522d55a8a89fe4 (patch)
treeca1d5540d63284e1714e36e558e354819bdf03c8 /doc/administration/integration
parentba2b3121cdf435b27fdd6dbe6c56490f36d3a917 (diff)
parent21cf3d2c3f39de8069c404932733068c3100a279 (diff)
downloadgitlab-ce-4bb1a3c159860083860a41c738522d55a8a89fe4.tar.gz
Merge branch 'feature/plantuml-restructured-text' into 'master'
Add documentation for PlantUML in reStructuredText See merge request !13900
Diffstat (limited to 'doc/administration/integration')
-rw-r--r--doc/administration/integration/plantuml.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/administration/integration/plantuml.md b/doc/administration/integration/plantuml.md
index b21817c1fd3..652ca9cf454 100644
--- a/doc/administration/integration/plantuml.md
+++ b/doc/administration/integration/plantuml.md
@@ -71,6 +71,15 @@ And in Markdown using fenced code blocks:
Alice -> Bob : Go Away
```
+And in reStructuredText using a directive:
+
+```
+.. plantuml::
+
+ Bob -> Alice: hello
+ Alice -> Bob: Go Away
+```
+
The above blocks will be converted to an HTML img tag with source pointing to the
PlantUML instance. If the PlantUML server is correctly configured, this should
render a nice diagram instead of the block:
@@ -94,4 +103,4 @@ Some parameters can be added to the AsciiDoc block definition:
Markdown does not support any parameters and will always use PNG format.
-[ce-8537]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8537 \ No newline at end of file
+[ce-8537]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8537