From 3de28c136106f642108b0b533f66479776836163 Mon Sep 17 00:00:00 2001 From: huyenngn Date: Mon, 17 Jun 2024 15:08:41 +0200 Subject: [PATCH] docs: Add docs for and --- docs/gen_images.py | 3 +++ docs/index.md | 48 ++++++++++++++++++++++++++++++++++++++++++---- 2 files changed, 47 insertions(+), 4 deletions(-) diff --git a/docs/gen_images.py b/docs/gen_images.py index 3f5d5c6a..2a884276 100644 --- a/docs/gen_images.py +++ b/docs/gen_images.py @@ -27,6 +27,9 @@ "educate Wizards": ("957c5799-1d4a-4ac0-b5de-33a65bf1519c", {}), "Weird guy": ("098810d9-0325-4ae8-a111-82202c0d2016", {}), "Top secret": ("5bf3f1e3-0f5e-4fec-81d5-c113d3a1b3a6", {}), + "Physical Node": ("fdb34c92-7c49-491d-bf11-dd139930786e", {}), + "Physical Behavior": ("313f48f4-fb7e-47a8-b28a-76440932fcb9", {}), + "Maintain": ("ee745644-07d7-40b9-ad7a-910dc8cbb805", {}), } interface_context_diagram_uuids: dict[str, tuple[str, dict[str, t.Any]]] = { "Left to right": ("3ef23099-ce9a-4f7d-812f-935f47e7938d", {}), diff --git a/docs/index.md b/docs/index.md index ce5ed877..b1d40d11 100644 --- a/docs/index.md +++ b/docs/index.md @@ -148,11 +148,52 @@ Available via `.context_diagram` on a [`ModelObject`][capellambse.model.common.e
Context diagram of educate Wizards LogicalFunction with type [LDFB]
-* [`pa.PhysicalComponent`][capellambse.model.layers.pa.PhysicalComponent] (PAB) -* [`pa.PhysicalFunction`][capellambse.model.layers.pa.PhysicalFunction] (PDFB) -* [`pa.PhysicalComponent`][capellambse.model.layers.pa.PhysicalComponent] (PAB) +- ??? example "[`pa.PhysicalComponent`][capellambse.model.layers.pa.PhysicalComponent] (PAB)" + + - Physical Node Component + + ``` py + import capellambse + + model = capellambse.MelodyModel("tests/data/ContextDiagram.aird") + diag = model.by_uuid("fdb34c92-7c49-491d-bf11-dd139930786e").context_diagram + diag.render("svgdiagram").save(pretty=True) + ``` +
+ +
Context of Physical Component [PAB]
+
+ + - Physical Behaviour Component + + ``` py + import capellambse + + model = capellambse.MelodyModel("tests/data/ContextDiagram.aird") + diag = model.by_uuid("313f48f4-fb7e-47a8-b28a-76440932fcb9").context_diagram + diag.render("svgdiagram").save(pretty=True) + ``` +
+ +
Context diagram of PC Software [PAB]
+
+ * [`pa.PhysicalFunction`][capellambse.model.layers.pa.PhysicalFunction] (PDFB) +- ??? example "[`pa.PhysicalFunction`][capellambse.model.layers.pa.PhysicalFunction] (PDFB)" + + ``` py + import capellambse + + model = capellambse.MelodyModel("tests/data/ContextDiagram.aird") + diag = model.by_uuid("ee745644-07d7-40b9-ad7a-910dc8cbb805").context_diagram + diag.render("svgdiagram").save(pretty=True) + ``` +
+ +
Context of Maintain Switch Firmware [PDFB]
+
+ #### Hierarchy in diagrams Hierarchical diagrams are diagrams where boxes have child boxes and edges @@ -206,7 +247,6 @@ The data is collected by [get_elkdata_for_exchanges][capellambse_context_diagram
Interface context diagram of Interface LogicalComponentExchange with type [LAB]
- !!! warning "Interface context only supported for the LogicalComponentExchanges" ### Customized edge routing