feat: #4 included class diagrams at runtime

Terradue · Dec 16, 2024 · b08985c · b08985c
1 parent e933046
commit b08985c
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 150 deletions.
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -17,5 +17,6 @@ jobs:
       run: |
         pip install hatch pdocs mkdocs-material mkdocs-jupyter mkdocs-plantuml-local pydoctor
         hatch build
+        pyreverse --all-ancestors --show-builtin --output svg --output-directory ./docs/puml/ --source-roots ./calrissian/ --verbose ./calrissian/
         pydoctor
         mkdocs gh-deploy --force
diff --git a/.gitignore b/.gitignore
@@ -16,3 +16,5 @@ env-calrissian*
 .pydevproject
 .cache
 site
+*/apidocs
+*.svg
diff --git a/docs/puml/class.md b/docs/puml/class.md
diff --git a/docs/puml/classes.md b/docs/puml/classes.md
@@ -0,0 +1,9 @@
+# Calrissian class diagram
+
+## Classes
+
+![Calrissian Class diagram](./classes.svg "Calrissian Class diagram")
+
+## Packages
+
+![Calrissian class diagram](./packages.svg "Calrissian Packages diagram")
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -16,6 +16,8 @@ markdown_extensions:
 - pymdownx.highlight
 - pymdownx.superfences
 - attr_list
+- markdown_include.include:
+    base_path: docs
 
 plugins:
 - search
@@ -43,4 +45,4 @@ nav:
   - 1.2.1: 'conformance/1.2.1.md'
 - Development:
   - API Docs: 'apidocs/index.html'
-  - Class diagram: 'puml/class.md'
+  - Class diagram: 'puml/classes.md'
-Original file line number
+Diff line change
@@ Expand Up / @@ -16,3 +16,5 @@ env-calrissian* @@
     .pydevproject
     .cache
     site
+    */apidocs
+    *.svg