EnergySystemsModellingLab / EnergySystemsModellingLab/MUSE_OS

Create UML diagrams

Open
#116 1 comment 0 reactions 0 assignees View on GitHub
documentation wontfix
Dominant language
Python
Stars
29
Forks
12
PR merge metrics
No merged PRs in 30d

Description

[UML diagrams](https://en.wikipedia.org/wiki/Unified_Modeling_Language) are useful to identify how classes and subclasses relate to each other in OOP, better understand relationships and identify redundancies or unknown links.

Potentially, it could use the same PlantUML extension mentioned in #112, but that one doesn't seem to extract the inheritance tree automatically, which is a pain. There is [an extension for Sphinx using `pyreverse`](https://pypi.org/project/sphinx-pyreverse/), but it does not seem to be maintained or reached a stable state, so probably not an option.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.