build proper documentation (#115)

* build proper documentation

* patch duplicated needs names in persistency

Author: PiotrKorkus

BUILD

@@ -15,13 +15,21 @@ load("@score_docs_as_code//:docs.bzl", "docs")
 
 docs(
     data = [
-        "@score_platform//:needs_json",
-        #"@score_persistency//:needs_json",  # cannot be included, as it does not contain any needs?
-        #"@score_orchestrator//:needs_json",  # some issue about score_toolchains_qnx?
-        #"@score_communication//:needs_json",  # no docs yet?
+        # Software components
+        "@score_persistency//:needs_json",
+        "@score_orchestrator//:needs_json",
+        "@score_kyron//:needs_json",
+        "@score_baselibs//:needs_json",
+        "@score_baselibs_rust//:needs_json",
+        # "@score_communication//:needs_json",  # no docs_sources
+        # "@score_lifecycle_health//:needs_json",  # unreadable images - relative paths issue
+        # "@score_logging//:needs_json",  # duplicated labels
+        "@score_logging//:needs_json",
         # "@score_feo//:needs_json",
-        "@score_docs_as_code//:needs_json",
+        # Tools
+        "@score_platform//:needs_json",
         "@score_process//:needs_json",
+        "@score_docs_as_code//:needs_json",
     ],
     source_dir = "docs",
 )

bazel_common/score_modules_target_sw.MODULE.bazel

@@ -48,6 +48,10 @@ git_override(
     module_name = "score_persistency",
     remote = "https://github.com/eclipse-score/persistency.git",
     commit = "9692dadab51c677183262e8870c5425ab1797c4f",
+    patches = [
+        "//patches/persistency:fix-duplicated-needs-name.patch",
+    ],
+    patch_strip = 1,
 )
 
 bazel_dep(name = "score_orchestrator")

bazel_common/score_modules_tooling.MODULE.bazel

@@ -56,6 +56,10 @@ bazel_dep(name = "score_docs_as_code")
 single_version_override(
     module_name = "score_docs_as_code",
     version = "3.0.1",
+    patches = [
+        "//patches/docs-as-code:fix-extra-properties.patch",
+    ],
+    patch_strip = 1,
 )
 
 bazel_dep(name = "score_process")

docs/index.rst

@@ -17,28 +17,38 @@ Reference Integration Documentation
 
 Newest Release Notes: :need:`doc__score_v05_beta_release_note`
 
-Verification Reports Summaries
-------------------------------
 
 .. toctree::
-   verification/verification
+   :caption: Software Components
+   :titlesonly:
+   :maxdepth: 1
+
+
+   _collections/score_persistency/docs/index
+   _collections/score_orchestrator/docs/index
+   _collections/score_kyron/docs/index
+   _collections/score_baselibs/docs/index
+   _collections/score_baselibs_rust/docs/index
+   _collections/score_logging/docs/index
+
+.. toctree::
+   :caption: Process, Methods, and Tools
+   :titlesonly:
+   :maxdepth: 1
 
-.. if-collection:: score_platform
+   _collections/score_platform/docs/index
+   _collections/score_process/process/index
+   _collections/score_docs_as_code/docs/index
 
-   .. toctree::
-      :maxdepth: 1
-      :titlesonly:
-      :caption: Platform and Modules
+.. toctree::
+   :caption: Code Quality
+   :titlesonly:
+   :glob:
 
-      S-CORE Platform <_collections/score_platform/docs/index>
-      place_holder/persistency
-      place_holder/orchestrator
-      place_holder/communication
+   verification/verification
 
-   .. toctree::
-      :maxdepth: 1
-      :titlesonly:
-      :caption: Process, Methods, and Tools
+.. toctree::
+   :hidden:
+   :glob:
 
-      _collections/score_process/process/index
-      _collections/score_docs_as_code/docs/index
+   verification/*

docs/place_holder/communication.rst

@@ -55,6 +55,9 @@
             "score_persistency": {
                 "repo": "https://github.com/eclipse-score/persistency.git",
                 "hash": "9692dadab51c677183262e8870c5425ab1797c4f",
+                "bazel_patches": [
+                    "//patches/persistency:fix-duplicated-needs-name.patch"
+                ],
                 "metadata": {
                     "code_root_path": "//src/...",
                     "exclude_test_targets": [
@@ -138,7 +141,10 @@
             },
             "score_docs_as_code": {
                 "repo": "https://github.com/eclipse-score/docs-as-code.git",
-                "version": "3.0.1"
+                "version": "3.0.1",
+                "bazel_patches": [
+                    "//patches/docs-as-code:fix-extra-properties.patch"
+                ]
             },
             "score_process": {
                 "repo": "https://github.com/eclipse-score/process_description.git",

docs/place_holder/orchestrator.rst

@@ -0,0 +1,23 @@
+diff --git a/src/extensions/score_source_code_linker/testlink.py b/src/extensions/score_source_code_linker/testlink.py
+index 50066fe3..51311f3e 100644
+--- a/src/extensions/score_source_code_linker/testlink.py
++++ b/src/extensions/score_source_code_linker/testlink.py
+@@ -93,7 +93,17 @@ class DataOfTestCase:
+ 
+     @classmethod
+     def from_dict(cls, data: dict[str, Any]):  # type-ignore
+-        return cls(**data)  # type-ignore
++        return cls(
++            name=data.get("name", ""),
++            file=data.get("file", ""),
++            line=data.get("line", ""),
++            result=data.get("result", ""),
++            TestType=data.get("TestType", ""),
++            DerivationTechnique=data.get("DerivationTechnique", ""),
++            result_text=data.get("result_text", ""),
++            PartiallyVerifies=data.get("PartiallyVerifies", ""),
++            FullyVerifies=data.get("FullyVerifies", ""),
++        )
+ 
+     @classmethod
+     def clean_text(cls, text: str):