Cameronsplaze / Cameronsplaze/AWS-ContainerManager

[Documentation Improvement] Add `pyreverse` generated docs to the Repo

Open
#115 0 comments 0 reactions 0 assignees View on GitHub
documentation enhancement good first issue
Dominant language
Python
Stars
2
Forks
0
Avg merge
1d 2h
Merged PRs (30d)
5

Description

### Is your feature request related to a problem? Please describe.

[Pyreverse](https://pylint.readthedocs.io/en/stable/pyreverse.html) (A sub-piece of [pylint](https://github.com/pylint-dev/pylint/tree/main/pylint/pyreverse)) generates a diagram on libraries, and how they link together. See if there's a way to add the .dot files it generates, to the README.

So far I got:

```bash
pyreverse --help
pyreverse ContainerManager --colorized -ASmy
```

But at first glance, there's modules it's missing. I'm guessing we'll need to add `__init__.py` files, and/or add paths to modules to existing ones.

After that, see how to render `*.dot` inside of markdown, or if there's a way to change the extension.

### Describe the solution you'd like

Either files generated (Probably won't worry about automating it, having actions push code gets messy) and docs on how to re-create the image each time, or this ticket is a wont-do.

### Describe alternatives you've considered

Just leave things as is... Not having this isn't huge.

### Acknowledgements

- [x] I may be able to implement this feature request
- [ ] This feature might incur a breaking change

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.