add variant results

avengineers · Jan 9, 2024 · f7bc87d · f7bc87d
1 parent 2778fb9
commit f7bc87d
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 23 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -23,7 +23,7 @@ include(FetchContent)
 FetchContent_Declare(
     spl-core
     GIT_REPOSITORY https://github.com/avengineers/spl-core.git
-    GIT_TAG feature/target-SWE.1-report-SWE.6
+    GIT_TAG v3.15.0
 )
 FetchContent_MakeAvailable(spl-core)
 

diff --git a/doc/components/index.rst b/doc/components/index.rst
@@ -4,15 +4,14 @@ Components
 {% for component_info in build_config.components_info %}
 {% if component_info.has_docs %}
 
-{{ component_info.long_name }}
---------------------
+{{ component_info.long_name or component_info.name }}
+-----------------------------------------------------
 
 .. toctree::
     :maxdepth: 2
 
     /{{ component_info.path }}/doc/index
 {% if (build_config.target == 'reports') and component_info.has_reports %}
-    /{{ component_info.reports_output_dir }}/unit_test_spec
     /{{ component_info.reports_output_dir }}/unit_test_results
     /{{ component_info.reports_output_dir }}/doxygen/html/index
     /{{ component_info.reports_output_dir }}/coverage

diff --git a/doc/customer_requirements/index.rst b/doc/customer_requirements/index.rst
@@ -7,25 +7,10 @@ Customer A - Disco Light
 
 Customer A requests a Disco Light that shall offer an ambient lighting experience that resonates with the rhythm of the surroundings.
 
-.. req:: Sync light with the ambient music
-   :id: R_001
-
-    The lighting shall automatically sync with any ambient music, adjusting its blink rate to match the beats or rhythm.
-
-.. req:: Option to choose a color for the light
-   :id: R_002
-
-    Users shall have the freedom to choose a specific color for the light. However, in the absence of a user-defined color, the software shall delight the user with randomized colors, ensuring an authentic disco experience.
-
-.. req:: The light transition must be adjustable
-   :id: R_003
-
-    As the essence of a disco environment is dynamic and lively, light transitions shall happen instantaneously without any lag.
-
-.. req:: The illumination must be adjustable
-   :id: R_004
-
-    The illumination provided shall be vibrant and noticeable, ranging from medium to high levels to keep up with the lively ambiance of disco settings.
+* RQ-1: The lighting shall automatically sync with any ambient music, adjusting its blink rate to match the beats or rhythm.
+* RQ-2: Users shall have the freedom to choose a specific color for the light. However, in the absence of a user-defined color, the software shall delight the user with randomized colors, ensuring an authentic disco experience.
+* RQ-3: As the essence of a disco environment is dynamic and lively, light transitions shall happen instantaneously without any lag.
+* RQ-4: The illumination provided shall be vibrant and noticeable, ranging from medium to high levels to keep up with the lively ambiance of disco settings.
 
 
 Customer B - Sleep Light

diff --git a/doc/results/index.rst b/doc/results/index.rst
@@ -0,0 +1,7 @@
+Requirements Traceability Matrix
+================================
+
+.. needtable::
+   :filter: type == 'req'
+   :columns: id, title, is tested by, is implemented by
+   :style: table
diff --git a/doc/software_requirements/index.rst b/doc/software_requirements/index.rst
@@ -0,0 +1,22 @@
+Software Requirements
+=====================
+
+.. req:: Sync light with the ambient music
+   :id: R_001
+
+    The lighting shall automatically sync with any ambient music, adjusting its blink rate to match the beats or rhythm.
+
+.. req:: Option to choose a color for the light
+   :id: R_002
+
+    Users shall have the freedom to choose a specific color for the light. However, in the absence of a user-defined color, the software shall delight the user with randomized colors.
+
+.. req:: The light transition must be adjustable
+   :id: R_003
+
+    As the essence of an environment is dynamic and lively, light transitions shall happen instantaneously without any lag.
+
+.. req:: The brightness must be adjustable
+   :id: R_004
+
+    The brightness provided shall be vibrant and noticeable, ranging from medium to high levels to keep up with the ambiance.
diff --git a/index.rst b/index.rst
@@ -29,11 +29,13 @@ Variant Report
     :caption: Contents
 
     doc/customer_requirements/index
+    doc/software_requirements/index
     doc/software_architecture/index
     doc/variants/index
     doc/components/index
 {% if build_config.target == 'reports' %}
     {{ build_config.reports_output_dir }}/coverage
 {% endif %}
+    doc/results/index
 
 {% endif %}