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.

Support Needs definition inside Plantuml

See original GitHub issue

I would like to define Needs within a Plantuml document like this:

@startuml

'@rst
'.. comp-sw:: MyAwesomeComponent
'  :id: COMP_SW_MyAwesomeComponent
'  :status: impemented
'  :tags: sys-arch
'@endrst

component MyAwesomeComponent 

@enduml

Issue Analytics

State:
Created a year ago
Comments:8 (4 by maintainers)

Top GitHub Comments

1reaction

danwoscommented, Aug 26, 2022

Maybe this can be better done by a generic extension, called e.g. rst-extractor. This extension could handle every text-based file and is not specific to uml and co.

Example

.. rst-extract:: myuml.puml
   :start: @rst
   :end: @endrst 
   :remove: '

.. rst-extract:: app.py
   :start: @rststart
   :end: @rstend

Could be used for rst, md, XML, python, c, …

Start/End arguments or comment prefixes can be configured.

0reactions

twodropscommented, Aug 26, 2022

This will be a real cool feature. Go ahead 😃

Top Results From Across the Web

Use the preprocessor - PlantUML

The PlantUML preprocessor provides features close to the C preprocessor. You can include files, define constant and macros. It's also possible to use ......

PlantUML Language Reference Guide

PlantUML is a component that allows to quickly write : • Sequence diagram. • Usecase diagram. • Class diagram. • Object diagram. •...

needuml - Sphinx-Needs 1.1.0 documentation

uml () supports key argument to define which PlantUML code to load from the Sphinx-Need object. key value by default is diagram ....

PlantUML Language Reference Guide

PlantUML is an Open Source project that allows to quickly write: • Sequence diagram, ... In the diagram definition, like any other commands,....

Markdown native diagrams with PlantUML - Andreas' Blog

This post covers PlantUML basics and how it can be used in GitLab or ... by defining your diagrams in plain text you...