feat: Add auto-generated UML diagram to docs #110
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #52
This pull request adds a UML class diagram to the main documentation page to help developers understand the project's code architecture.
Key Changes:
.pre-commit-config.yamlto automatically generate the diagram usingpyreverseandgraphviz.make umlcommand in theMakefile.docs/index.mdpage.docs/setup.mdguide was updated to includegraphvizas a required development dependency.