Mermaid UML Diagrams

[ColtAllen]

We're currently using pylint to create PNG images for the codebase UML diagrams. What are everyone's thoughts on using Mermaid to create these diagrams instead?

requirementDiagram

    requirement test_req {
    id: 1
    text: the test text.
    risk: high
    verifymethod: test
    }

    element test_entity {
    type: simulation
    }

    test_entity - satisfies -> test_req

Loading

pymermaider is written in rust and can auto-generate UML diagrams from python code. The only downside is that I'm not sure how to embed external text into a markdown file.

[wd60622]

I'm for this if this can be interactive! Either embed in markdown file or as standalone file.

Is it hard to embed in the sphinx docs as well? Say here: https://www.pymc-marketing.io/en/stable/contributing/index.html

[ColtAllen]

I'm for this if this can be interactive! Either embed in markdown file or as standalone file.

Is it hard to embed in the sphinx docs as well? Say here: https://www.pymc-marketing.io/en/stable/contributing/index.html

There's a mermaid plugin for sphinx, but the syntax seems slightly different:

https://github.com/mgaitan/sphinxcontrib-mermaid