Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Document plantuml usage

See original GitHub issue

Document how to use sphinxcontrib-plantuml with RTD.

Because X11 isn’t exposed through docker, java needs to be called in headless mode. Heck, we can likely set this in our conf.py template as well, so that users have the correct config.

To get it to work, you’ll need:

plantuml = 'java -Djava.awt.headless=true -jar /usr/share/plantuml/plantuml.jar'

Also, you need to run the latest image.

Issue Analytics

State:
Created 5 years ago
Reactions:1
Comments:8 (2 by maintainers)

Top GitHub Comments

2reactions

danwoscommented, Nov 19, 2019

Thanks for providing the needed plantuml command 👍

The extension Sphinx-Needs is using plantuml for some stuff and I have just added an installation section how to use it for rtd: https://sphinxcontrib-needs.readthedocs.io/en/latest/installation.html#install-plantuml

If I find some time, I’ll write the needed docs. But unfortunately not in the next days.

So here is the text as screenshot. For the latest version (and text to copy) see link above.

1reaction

danwoscommented, Sep 12, 2022

Thanks for the fast answer. I have created an extra issue: #9599

Top Results From Across the Web

Open-source tool that uses simple textual descriptions to draw ...

Easily create beautiful UML Diagrams from simple textual description. There are also numerous kind of available diagrams. It's also possible to export ...

Ashley's PlantUML Documentation — Ashley's PlantUML Doc ...

This is documentation about how to use PlantUML the commands, keywords, options, and other information you need to produce diagrams with PlantUML.

PlantUML Language Reference Guide

You can use reference in a diagram, using the keyword ref over. @startuml ... In a configuration file, provided in the command line...

Productivity Hack: Visual Documentation Using PlantUML

We can use this tool for visual documentation purposes as it has in-built support to a class, object, sequence, activity, and use case...

Create UML Diagrams using PlantUML | The .NET Tools Blog

Use the PlantUML toolwindow to manage diagrams, for example, refreshing or zooming into a diagram. You may want to save them as a...