Embed a plantuml diagram somewhere in a docstring (with the Sphinx plantuml extension)

Question

I installed the sphinxcontrib-plantuml extension which works fine if I run the HTML builder e.g. with following testmodule.rst file for a corresponding testmodule.py file:

testmodule module
=================

.. automodule:: testmodule
    :members:
    :undoc-members:
    :show-inheritance:

.. uml::
   
   Alice -> Bob: Hi!
   Alice <- Bob: How are you?

This adds the UML diagram at the very end of the document. Unfortunately I didn't find out how to embed a UML diagram anywhere in the documentation e.g. somewhere in the middle of a methods docstring block.

Does anyone know how to do that?

Have you tried to add an UML diagram in a docstring? What happened? — mzjn, Dec 15 '20 at 14:03

score 3 · Accepted Answer · answered Dec 16 '20 at 07:24

Adding the UML diagram directly in the docstring section didn't work for me. But following worked for me:

Put plantuml code in separate file e.g. diagram.uml:

@startuml
   Alice -> Bob: Hi!
   Alice <- Bob: How are you?
@enduml

Add the plantuml directive with the filename at the desired place in the docstring. E.g.:

def example():
    """
    some text

    .. uml:: diagram.uml

    some more text 
    """
    ...

Embed a plantuml diagram somewhere in a docstring (with the Sphinx plantuml extension)

1 Answers1