Skip to main content

All Questions

Tagged with
2 votes
1 answer
208 views

How to Cross-Reference Plantuml Diagram in Sphinx

I am writing some documentation in Sphinx and cannot figure out how to reference a plantuml diagram in text. Using the numref role I can reference figures via a label, e.g., :numref:`diag`. In text ...
Ali's user avatar
  • 31
0 votes
1 answer
228 views

How to reference a text block several times in a document?

I am writing lots of Sphinx/RestructuredText and this includes Sequence Diagrams using PlantUML. I have lots of text that I am reusing, so to make things cleaner, I created a definitions.iuml file. In ...
Michael Norton's user avatar
1 vote
1 answer
568 views

Sphinx/PlantUML error when trying to create DOCX

Fedora Box: I have worked with Sphinx and PlantUML the past few months and have gotten pretty familiar with it. Specifically getting it to build via HTML, PDF, and DOCX. But I am running into an ...
Michael Norton's user avatar
4 votes
1 answer
2k views

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

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 ===========...
El tornillo's user avatar
1 vote
1 answer
234 views

Using Plantuml when publishing on RTD server

I just managed to display my documentation on the RTD server. (https://uracoli-rsensor.readthedocs.io/). In the Sphinx-RST file I have a ".. uml::" statement, which renders nicely when I build the ...
Axel Wachtler's user avatar
0 votes
1 answer
5k views

How can I include a plantuml file in reStructuredText with Sphinx

I have a plantuml file composite.puml with the following content: package composite { class Letter { + __init__(char: str) # print_this_before() } And I try to include this in a ...
Johan Vergeer's user avatar
2 votes
1 answer
2k views

sphinx doc: How to render dynamic rst content inside sphinx event handlers?

I'm the maintainer of sphinx-needs, which allows the definition of requirements, bugs, ... These objects get stored inside the related directive run function and I finally get a list of all objects ...
danwos's user avatar
  • 500
1 vote
2 answers
472 views

How to configure epstopdf for the Sphinx plantuml extension?

I'm trying to get Sphinx on Windows to generate a PDF with the rst2pdf plugin. My reStructuredText files make use of the PlantUML Sphinx extension. When generating a PDF, I get the message ...
Frank Kusters's user avatar