Merge pull request #201 from pymc-labs/uml

Improve UML image generation
pymc-labs · Jun 14, 2023 · 6817574 · 6817574
2 parents c0f9650 + a25da0a
commit 6817574
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 6 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -169,18 +169,18 @@ Docs are built in `docs/_build`, but these docs are _not_ committed to the GitHu
 
 ## Overview of code structure
 
-UML diagrams can be created with the command below. If you have not already done so, you may need to `pip install 'causalpy[lint]'` in order to install `pyreverse`.
-
-```bash
-pyreverse -o png causalpy --output-directory docs/source/_static
-```
-
 Classes
 ![](docs/source/_static/classes.png)
 
 Packages
 ![](docs/source/_static/packages.png)
 
+UML diagrams can be created with the command below.
+
+```bash
+make uml
+```
+
 ---
 
 This guide takes some inspiration from the [Bambi guide to contributing](https://github.com/bambinos/bambi/blob/main/docs/CONTRIBUTING.md)
diff --git a/Makefile b/Makefile
@@ -20,3 +20,7 @@ check_lint:
 test:
 	pip install causalpy[test]
 	pytest
+
+uml:
+	pip install pylint
+	pyreverse -o png causalpy --output-directory docs/source/_static --ignore tests
diff --git a/docs/source/_static/classes.png b/docs/source/_static/classes.png
diff --git a/docs/source/_static/packages.png b/docs/source/_static/packages.png