power-grid-model icon indicating copy to clipboard operation
power-grid-model copied to clipboard

[FEATURE] Autogenerate class/module diagrams for Python

Open mgovers opened this issue 6 months ago • 0 comments

Use pyreverse (distributed together with pylint by default) to create module graph and class diagram

  • [ ] Create a module graph of the python library
  • [ ] Create a class diagram of the Python library in the github action that generates the documentation
  • [ ] Add to the documentation generation action in https://github.com/PowerGridModel/power-grid-model/blob/main/.readthedocs.yaml
  • [ ] Include in the documentation
    • [ ] TBD: In which file do we want to put it?
    • [ ] NOTE: If this decision has not been made by the time this issue is picked up, then you can submit it without explicitly including it in the documentation and let the maintainers handle that.

mgovers avatar Aug 16 '24 08:08 mgovers