From 0104c5ede356d14d68a7afdf42ecd8755700fe2b Mon Sep 17 00:00:00 2001 From: Andreas Mittag Date: Thu, 27 Aug 2026 14:15:55 +0000 Subject: [PATCH 1/2] stkh_req and feat_req as code not as need --- .../docs/architecture_modeling_example.rst | 47 ++++++++++--------- 1 file changed, 26 insertions(+), 21 deletions(-) diff --git a/examples/docs/architecture_modeling_example.rst b/examples/docs/architecture_modeling_example.rst index ffd7a96a..07be21cd 100644 --- a/examples/docs/architecture_modeling_example.rst +++ b/examples/docs/architecture_modeling_example.rst @@ -295,32 +295,37 @@ Requirements for the Example .. note:: The stakeholder requirements shall be defined in the platform repo (`stakeholder requirements folder `_) and imported as sphinx needs objects. Here it is defined only to hold the example together and prevent errors because the sphinx needs meta model have mandatory links to it. -.. stkh_req:: Example Stkh Req - :id: stkh_req__mtfn__example_req - :reqtype: Functional - :safety: ASIL_B - :security: YES - :rationale: needed for archdes example - :status: valid - :version: 1 - :valid_from: v1.0.0 +.. code:: + + .. stkh_req:: Example Stkh Req + :id: stkh_req__mtfn__example_req + :reqtype: Functional + :safety: ASIL_B + :security: YES + :rationale: needed for archdes example + :status: valid + :version: 1 + :valid_from: v1.0.0 - The platform shall provide the feature .... + The platform shall provide the feature .... .. note:: The feature requirements shall be defined in the platform repo (in the requirements folder of the (`features `_)) and imported as sphinx needs objects. Here it is defined only to hold the example together and prevent errors because the sphinx needs meta model have mandatory links to it. -.. feat_req:: Example Feature Req - :id: feat_req__example_feature__example_req - :reqtype: Functional - :security: YES - :safety: ASIL_B - :derived_from: stkh_req__mtfn__example_req - :status: valid - :version: 1 - :valid_from: v1.0.0 - :satisfied_by: feat__mtef +.. code:: + + .. feat_req:: Example Feature Req + :id: feat_req__example_feature__example_req + :reqtype: Functional + :security: YES + :safety: ASIL_B + :derived_from: stkh_req__mtfn__example_req + :status: valid + :version: 1 + :valid_from: v1.0.0 + :satisfied_by: feat__mtef + + The feature shall provide the functionality to .... - The feature shall provide the functionality to .... .. comp_req:: Example Component Req :id: comp_req__example_feature__example_req From 3c7ab39b9f33ae4f37f8524e31108953657b162c Mon Sep 17 00:00:00 2001 From: Andreas Mittag Date: Thu, 27 Aug 2026 14:29:09 +0000 Subject: [PATCH 2/2] review findings corrected --- examples/docs/architecture_modeling_example.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/docs/architecture_modeling_example.rst b/examples/docs/architecture_modeling_example.rst index 07be21cd..0725fd16 100644 --- a/examples/docs/architecture_modeling_example.rst +++ b/examples/docs/architecture_modeling_example.rst @@ -295,7 +295,7 @@ Requirements for the Example .. note:: The stakeholder requirements shall be defined in the platform repo (`stakeholder requirements folder `_) and imported as sphinx needs objects. Here it is defined only to hold the example together and prevent errors because the sphinx needs meta model have mandatory links to it. -.. code:: +.. code-block:: rst .. stkh_req:: Example Stkh Req :id: stkh_req__mtfn__example_req @@ -311,7 +311,7 @@ Requirements for the Example .. note:: The feature requirements shall be defined in the platform repo (in the requirements folder of the (`features `_)) and imported as sphinx needs objects. Here it is defined only to hold the example together and prevent errors because the sphinx needs meta model have mandatory links to it. -.. code:: +.. code-block:: rst .. feat_req:: Example Feature Req :id: feat_req__example_feature__example_req