Skip to content

Commit 32c1f90

Browse files
committed
merge: Add a brief "look & feel" intro to the docs landing page (#537)
2 parents bed8a92 + fb7fa68 commit 32c1f90

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

docs/source/index.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,33 @@ Python Capella MBSE Tools
1515

1616
**Date**: |today| **Version**: |Version|
1717

18+
.. code:: python
19+
20+
>>> import capellambse
21+
>>> model = capellambse.MelodyModel("git+https://github.com/DSD-DBS/coffee-machine.git")
22+
>>> model.search("SystemFunction").by_name("make coffee")
23+
<SystemFunction 'make coffee' (8b0d19df-7446-4c3a-98e7-4a739c974059)>
24+
.available_in_states = [0] <State 'Ready for request' (15e28744-1a3b-41ce-a2ee-28fb33ed3bda)>
25+
.context_diagram = <Diagram 'Context of make coffee'>
26+
.inputs = [0] <FunctionInputPort 'FIP 1' (9a409efc-75bc-44b5-8888-8abefebc69d0)>
27+
[1] <FunctionInputPort 'FIP 1' (fac29291-c465-4130-a95b-8dbdd8a9a5cf)>
28+
.is_leaf = True
29+
.kind = <FunctionKind.FUNCTION: 'FUNCTION'>
30+
.layer = <SystemAnalysis 'System Analysis' (fe55c3c2-28d3-4d80-b54d-aae12cdc6bc6)>
31+
.name = 'make coffee'
32+
.outputs = [0] <FunctionOutputPort 'FOP 1' (2bd6785b-08ff-4108-b6f0-c8fd94ab08c0)>
33+
[1] <FunctionOutputPort 'FOP 2' (1dc12e9d-14f6-494f-9dfc-867635951e91)>
34+
[2] <FunctionOutputPort 'FOP 3' (c87688f6-adc7-45e2-b254-8f22e85fec4b)>
35+
.parent = <SystemFunction 'Root System Function' (eff8d0b0-84df-431e-aec8-66150a0b1365)>
36+
.pvmt = <Property Value Management for <SystemFunction 'make coffee' (8b0d19df-7446-4c3a-98e7-4a739c974059)>>
37+
.realization_view = <Diagram 'Realization view of make coffee'>
38+
.uuid = '8b0d19df-7446-4c3a-98e7-4a739c974059'
39+
.visible_on_diagrams = [0] <Diagram '[ES] make coffee'>
40+
[1] <Diagram '[ES] make coffee (refined)'>
41+
[2] <Diagram '[SDFB] make coffee'>
42+
[3] <Diagram '[SAB] make coffee'>
43+
.xtype = 'org.polarsys.capella.core.data.ctx:SystemFunction'
44+
1845
Description
1946
-----------
2047

0 commit comments

Comments
 (0)