Skip to content

Add SysML / Gaphor diagrams under sphinx-needs items (prototype) #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ubmarco wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add SysML / Gaphor diagrams under sphinx-needs items (prototype) #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
136154b
Add SysML / Gaphor diagrams under sphinx-needs items
ubmarco May 5, 2026
cb96b17
Pre-render SysML SVGs; drop Cairo / Gaphor build dependency
ubmarco May 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/automotive-adas/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
sys_4_sys_integation_tests
sys_5_sys_quali_test
sys_5_sys_quali_test_results
sysml/index


V-model and service connectors
Expand Down
12 changes: 12 additions & 0 deletions docs/automotive-adas/sys_3_sys_arch.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,11 @@ SYS.3 Architecture Design
Design the system architecture for traffic sign recognition, including camera
capture, sign classification, and distribution of detected speed limits to vehicle control functions.

The component view (PlantUML) and the SysML Block Definition Diagram below
describe the same architecture from two notations. The BDD is a static
SVG pre-rendered from a ``.gaphor`` model — see :ref:`SysML_Demo` for
the workflow.

.. uml::

@startuml
Expand All @@ -229,3 +234,10 @@ SYS.3 Architecture Design
TrafficSignRecognition --> SignInterpreter
SignInterpreter --> VehicleControl
@enduml

.. figure:: sysml/adas-tsr-bdd__tsr-block-definition.svg
:align: center
:alt: SysML Block Definition Diagram for the Traffic Sign Recognition system

SysML BDD: ``TrafficSignRecognition`` decomposed into ``FrontCamera``,
``SignInterpreter`` and ``VehicleControl`` parts.
243 changes: 243 additions & 0 deletions docs/automotive-adas/sysml/adas-tsr-bdd.gaphor
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,243 @@
<?xml version="1.0" encoding="utf-8"?>
<gaphor xmlns="https://gaphor.org/model" xmlns:SysML="https://gaphor.org/modelinglanguage/SysML" xmlns:UML="https://gaphor.org/modelinglanguage/UML" version="4" gaphor-version="3.3.2">
<model>
<UML:Package id="186b2924-486c-11f1-8fca-9f0ab78f1b24">
<name>
<val>ADAS</val>
</name>
<ownedDiagram>
<reflist>
<ref refid="186b5566-486c-11f1-8fca-9f0ab78f1b24"/>
</reflist>
</ownedDiagram>
<ownedType>
<reflist>
<ref refid="186b2b4a-486c-11f1-8fca-9f0ab78f1b24"/>
<ref refid="186b3586-486c-11f1-8fca-9f0ab78f1b24"/>
<ref refid="186b3842-486c-11f1-8fca-9f0ab78f1b24"/>
<ref refid="186b3a54-486c-11f1-8fca-9f0ab78f1b24"/>
</reflist>
</ownedType>
<packagedElement>
<reflist>
<ref refid="186b2b4a-486c-11f1-8fca-9f0ab78f1b24"/>
<ref refid="186b3586-486c-11f1-8fca-9f0ab78f1b24"/>
<ref refid="186b3842-486c-11f1-8fca-9f0ab78f1b24"/>
<ref refid="186b3a54-486c-11f1-8fca-9f0ab78f1b24"/>
</reflist>
</packagedElement>
</UML:Package>
<SysML:Block id="186b2b4a-486c-11f1-8fca-9f0ab78f1b24">
<name>
<val>TrafficSignRecognition</val>
</name>
<ownedAttribute>
<reflist>
<ref refid="186b3c3e-486c-11f1-8fca-9f0ab78f1b24"/>
<ref refid="186b476a-486c-11f1-8fca-9f0ab78f1b24"/>
<ref refid="186b4fee-486c-11f1-8fca-9f0ab78f1b24"/>
</reflist>
</ownedAttribute>
<owningPackage>
<ref refid="186b2924-486c-11f1-8fca-9f0ab78f1b24"/>
</owningPackage>
<package>
<ref refid="186b2924-486c-11f1-8fca-9f0ab78f1b24"/>
</package>
<presentation>
<reflist>
<ref refid="186b59d0-486c-11f1-8fca-9f0ab78f1b24"/>
</reflist>
</presentation>
</SysML:Block>
<SysML:Block id="186b3586-486c-11f1-8fca-9f0ab78f1b24">
<name>
<val>FrontCamera</val>
</name>
<owningPackage>
<ref refid="186b2924-486c-11f1-8fca-9f0ab78f1b24"/>
</owningPackage>
<package>
<ref refid="186b2924-486c-11f1-8fca-9f0ab78f1b24"/>
</package>
<presentation>
<reflist>
<ref refid="186dd46c-486c-11f1-8fca-9f0ab78f1b24"/>
</reflist>
</presentation>
</SysML:Block>
<SysML:Block id="186b3842-486c-11f1-8fca-9f0ab78f1b24">
<name>
<val>SignInterpreter</val>
</name>
<owningPackage>
<ref refid="186b2924-486c-11f1-8fca-9f0ab78f1b24"/>
</owningPackage>
<package>
<ref refid="186b2924-486c-11f1-8fca-9f0ab78f1b24"/>
</package>
<presentation>
<reflist>
<ref refid="186ef964-486c-11f1-8fca-9f0ab78f1b24"/>
</reflist>
</presentation>
</SysML:Block>
<SysML:Block id="186b3a54-486c-11f1-8fca-9f0ab78f1b24">
<name>
<val>VehicleControl</val>
</name>
<owningPackage>
<ref refid="186b2924-486c-11f1-8fca-9f0ab78f1b24"/>
</owningPackage>
<package>
<ref refid="186b2924-486c-11f1-8fca-9f0ab78f1b24"/>
</package>
<presentation>
<reflist>
<ref refid="186fff9e-486c-11f1-8fca-9f0ab78f1b24"/>
</reflist>
</presentation>
</SysML:Block>
<UML:Property id="186b3c3e-486c-11f1-8fca-9f0ab78f1b24">
<aggregation>
<val>composite</val>
</aggregation>
<name>
<val>camera</val>
</name>
<structuredClassifier>
<ref refid="186b2b4a-486c-11f1-8fca-9f0ab78f1b24"/>
</structuredClassifier>
<type>
<ref refid="186b3586-486c-11f1-8fca-9f0ab78f1b24"/>
</type>
</UML:Property>
<UML:Property id="186b476a-486c-11f1-8fca-9f0ab78f1b24">
<aggregation>
<val>composite</val>
</aggregation>
<name>
<val>interpreter</val>
</name>
<structuredClassifier>
<ref refid="186b2b4a-486c-11f1-8fca-9f0ab78f1b24"/>
</structuredClassifier>
<type>
<ref refid="186b3842-486c-11f1-8fca-9f0ab78f1b24"/>
</type>
</UML:Property>
<UML:Property id="186b4fee-486c-11f1-8fca-9f0ab78f1b24">
<aggregation>
<val>composite</val>
</aggregation>
<name>
<val>control</val>
</name>
<structuredClassifier>
<ref refid="186b2b4a-486c-11f1-8fca-9f0ab78f1b24"/>
</structuredClassifier>
<type>
<ref refid="186b3a54-486c-11f1-8fca-9f0ab78f1b24"/>
</type>
</UML:Property>
<SysML:BlockDefinitionDiagram id="186b5566-486c-11f1-8fca-9f0ab78f1b24">
<element>
<ref refid="186b2924-486c-11f1-8fca-9f0ab78f1b24"/>
</element>
<name>
<val>TSR Block Definition</val>
</name>
<ownedPresentation>
<reflist>
<ref refid="186b59d0-486c-11f1-8fca-9f0ab78f1b24"/>
<ref refid="186dd46c-486c-11f1-8fca-9f0ab78f1b24"/>
<ref refid="186ef964-486c-11f1-8fca-9f0ab78f1b24"/>
<ref refid="186fff9e-486c-11f1-8fca-9f0ab78f1b24"/>
</reflist>
</ownedPresentation>
</SysML:BlockDefinitionDiagram>
<SysML:BlockItem id="186b59d0-486c-11f1-8fca-9f0ab78f1b24">
<matrix>
<val>(1.0, 0.0, 0.0, 1.0, 200.0, 40.0)</val>
</matrix>
<top-left>
<val>(0.0, 0.0)</val>
</top-left>
<width>
<val>240.0</val>
</width>
<height>
<val>160.0</val>
</height>
<diagram>
<ref refid="186b5566-486c-11f1-8fca-9f0ab78f1b24"/>
</diagram>
<show_parts>
<val>1</val>
</show_parts>
<subject>
<ref refid="186b2b4a-486c-11f1-8fca-9f0ab78f1b24"/>
</subject>
</SysML:BlockItem>
<SysML:BlockItem id="186dd46c-486c-11f1-8fca-9f0ab78f1b24">
<matrix>
<val>(1.0, 0.0, 0.0, 1.0, 40.0, 280.0)</val>
</matrix>
<top-left>
<val>(0.0, 0.0)</val>
</top-left>
<width>
<val>160.0</val>
</width>
<height>
<val>70.0</val>
</height>
<diagram>
<ref refid="186b5566-486c-11f1-8fca-9f0ab78f1b24"/>
</diagram>
<subject>
<ref refid="186b3586-486c-11f1-8fca-9f0ab78f1b24"/>
</subject>
</SysML:BlockItem>
<SysML:BlockItem id="186ef964-486c-11f1-8fca-9f0ab78f1b24">
<matrix>
<val>(1.0, 0.0, 0.0, 1.0, 240.0, 280.0)</val>
</matrix>
<top-left>
<val>(0.0, 0.0)</val>
</top-left>
<width>
<val>160.0</val>
</width>
<height>
<val>70.0</val>
</height>
<diagram>
<ref refid="186b5566-486c-11f1-8fca-9f0ab78f1b24"/>
</diagram>
<subject>
<ref refid="186b3842-486c-11f1-8fca-9f0ab78f1b24"/>
</subject>
</SysML:BlockItem>
<SysML:BlockItem id="186fff9e-486c-11f1-8fca-9f0ab78f1b24">
<matrix>
<val>(1.0, 0.0, 0.0, 1.0, 440.0, 280.0)</val>
</matrix>
<top-left>
<val>(0.0, 0.0)</val>
</top-left>
<width>
<val>160.0</val>
</width>
<height>
<val>70.0</val>
</height>
<diagram>
<ref refid="186b5566-486c-11f1-8fca-9f0ab78f1b24"/>
</diagram>
<subject>
<ref refid="186b3a54-486c-11f1-8fca-9f0ab78f1b24"/>
</subject>
</SysML:BlockItem>
</model>
</gaphor>
Loading
Loading