Inheritance diagrams

[corykinney]

Describe the solution you'd like
It would be interesting to have the option to display a generated inheritance diagram with links to the documentation for parent/child classes. This could be a good option for a second Insiders funding tier.

classDiagram
    class Parent
    link Parent "#module.Parent"
    Parent <|-- Child 

Loading

The mermaid.js classDiagram is designed for inheritance diagrams like this and even supports linking. I imagine it wouldn't be too hard to parse the inheritance structure and assemble the corresponding diagram syntax, for example:

classDiagram
    class Parent
    link Parent "#module.Parent"
    Parent <|-- Child 

The option could be off by default and toggled on specific classes like so:

options:
  show_inheritance_diagram: True

[pawamoy]

Hi @corykinney, that's a cool idea! Thanks for the suggestion, I'll keep that in mind 🙂

[pawamoy]

I have implemented this, see the docs. It's in the $1500/month funding goal. Live example here.

For now, I used simple flowcharts, as I was afraid showing all attributes and all methods in a real Mermaid classDiagram by default would most of the times create too big diagrams, rendering them unreadable. We can totally reconsider and iterate an improved version later, of course (not as a new insiders feature, just as an enhancement 👍).

Each node in the flowchart is clickable and will link to the corresponding class 🙂
Feedback welcome!

[corykinney]

Nice! Hopefully that funding goal will get reached so we can see this in the non-insiders version! Thanks again.