Provided exemple in README does not render to UML diagram

[elDan101]

The example in the README:

.. uml::

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

didn't render for me (I just started with both Sphinx and this extension, so I may have done something wrong). Instead, I got an image with the plantuml text.

Embedding the plantuml code in @startuml and @enduml fixed it for me

.. uml::

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

[yuja]

Maybe the compatibility mode of -pipe is temporarily broken?
Can you try other versions of plantuml?

http://plantuml.com/faq
"Is @startuml needed in with -pipe flag ?"

Unfortunately, since some existing scripts were already using the fact that @startuml is not needed in -pipe flag, it has been decided to keep this as a deprecated option, just to allow older scripts to run. We indeed do pay attention of ascending compatibility.

Unfortunately, @startuml can't be inserted automatically by the Sphinx extension
since users may already have .. uml:: containing @startuml.

[elDan101]

I used plantuml==03.2018 and now updated to plantuml==05.2018, the issue remained.

I haven't tried older versions.

Unfortunately, @startuml can't be inserted automatically by the Sphinx extension
since users may already have .. uml:: containing @startuml.

If it is expected that this does not work for others with current versions of plantuml I suggest to update the README by including a note.

[HustLion]

It doesn't render at all. I'm using the newest Sphinx(Sphinx-1.8.1-py2.py3-none-any.whl) and plantuml(plantuml.1.2018.11.jar).

source:

.. uml::

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

This is the result:

[wolfmanx]

@HustLion I am using Sphinx 1.8.1 and plantuml.1.2018.13.jar. Both examples (with and without @startuml) work perfectly fine.

However, I had Sphinx 1.8.2 installed temporarily and that failed for me in the same way you describe.