Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Implement UML diagram for classes #349

Merged
merged 2 commits into from
Aug 8, 2023

Conversation

titom73
Copy link
Collaborator

@titom73 titom73 commented Aug 8, 2023

Overview

Implementation of visual representation of object with their dependencies.

Pylint comes with a tool named pyreverse that can generate UML diagram for
Python class and modules.

Usage

pyreverse anta --colorized -a1 -s1 -o jpeg -m true -k --output-directory docs/imgs/uml/ -c anta.device.AntaDevice

Requirements

To be able to generate JPEG output, it is important to install graphviz

@titom73 titom73 added the documentation Improvements or additions to documentation label Aug 8, 2023
@mtache
Copy link
Collaborator

mtache commented Aug 8, 2023

Could we have this beautiful line of shell in the contribution guide ? :)

@titom73
Copy link
Collaborator Author

titom73 commented Aug 8, 2023

Could we have this beautiful line of shell in the contribution guide ? :)

Done

Copy link
Collaborator

@mtache mtache left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome diagrams !

@mtache mtache merged commit 69341a7 into aristanetworks:main Aug 8, 2023
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation rn: doc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants