Skip to content

Support PlantUML blocks in reStructuredText

What does this MR do?

Adds support for PlantUML blocks in the following format:

.. plantuml::

   Bob -> Alice: hello
   Alice -> Bob: Go Away

Based on the Markdown approach in https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8588, the real work is done by Banzai::Filter::PlantumlFilter.

This development is sponsored by Siemens (/cc @bufferoverflow)

Are there points in the code the reviewer needs to double check?

  • We could consider using uml:: instead of plantuml:: to match sphinxcontrib-plantuml, I decided to use the latter since we don't support the additional options from sphinxcontrib
  • All <pre> tags now also contain a <code> tag, this looks the same on GitLab but might break layout if this gem is used outside of it
Edited by Gabriel Mazetto

Merge request reports