From 3f0657704bc19d95e72743f39b19638438e2a255 Mon Sep 17 00:00:00 2001 From: Andreas Zwinkau Date: Thu, 20 Nov 2025 11:37:53 +0100 Subject: [PATCH 1/2] Extend documentation --- .gitignore | 1 + BUILD | 8 +++++--- docs/index.rst | 14 ++++++++++++-- docs/place_holder/communication.rst | 5 +++++ docs/place_holder/orchestrator.rst | 5 +++++ docs/place_holder/persistency.rst | 5 +++++ 6 files changed, 33 insertions(+), 5 deletions(-) create mode 100644 docs/place_holder/communication.rst create mode 100644 docs/place_holder/orchestrator.rst create mode 100644 docs/place_holder/persistency.rst diff --git a/.gitignore b/.gitignore index 26b5e28ab..ca2081e49 100644 --- a/.gitignore +++ b/.gitignore @@ -21,3 +21,4 @@ __pycache__/ # Docs /_build /docs/ubproject.toml +/docs/_collections diff --git a/BUILD b/BUILD index 8ef451a21..2d6570fe8 100644 --- a/BUILD +++ b/BUILD @@ -16,10 +16,12 @@ 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? + "@score_feo//:needs_json", + "@score_docs_as_code//:needs_json", "@score_process//:needs_json", - # Persistency cannot be included, as it does not contain any needs. - # -> sphinx-needs bug? - # "@score_persistency//:needs_json", ], source_dir = "docs", ) diff --git a/docs/index.rst b/docs/index.rst index efb54f712..03b500f59 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,11 +20,21 @@ Release Notes: :need:`doc__score_v05_alpha_release_note` .. if-collection:: score_platform - Documentation: - .. toctree:: :maxdepth: 1 :titlesonly: + :caption: Platform and Modules S-CORE Platform <_collections/score_platform/docs/index> + place_holder/persistency + place_holder/orchestrator + place_holder/communication + FEO <_collections/score_feo/docs/index> + + .. toctree:: + :maxdepth: 1 + :titlesonly: + :caption: Process, Methods, and Tools + _collections/score_process/process/index + _collections/score_docs_as_code/docs/index diff --git a/docs/place_holder/communication.rst b/docs/place_holder/communication.rst new file mode 100644 index 000000000..d20d5acca --- /dev/null +++ b/docs/place_holder/communication.rst @@ -0,0 +1,5 @@ +============= +Communication +============= + +No communication available yet. diff --git a/docs/place_holder/orchestrator.rst b/docs/place_holder/orchestrator.rst new file mode 100644 index 000000000..fed4aeab2 --- /dev/null +++ b/docs/place_holder/orchestrator.rst @@ -0,0 +1,5 @@ +============ +Orchestrator +============ + +Actual documentation is found here: https://eclipse-score.github.io/orchestrator/main/ diff --git a/docs/place_holder/persistency.rst b/docs/place_holder/persistency.rst new file mode 100644 index 000000000..678510015 --- /dev/null +++ b/docs/place_holder/persistency.rst @@ -0,0 +1,5 @@ +=========== +Persistency +=========== + +Actual documentation is found here: https://eclipse-score.github.io/persistency/main/ From dc5bac3e0a62052cad2b8f836e76c661306a0f4b Mon Sep 17 00:00:00 2001 From: Andreas Zwinkau Date: Fri, 21 Nov 2025 15:59:08 +0100 Subject: [PATCH 2/2] Fix collection error Use docs-as-code revisision with short-term fix for #305 --- score_modules.MODULE.bazel | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/score_modules.MODULE.bazel b/score_modules.MODULE.bazel index 5855393ce..3cdc4cbe0 100644 --- a/score_modules.MODULE.bazel +++ b/score_modules.MODULE.bazel @@ -60,9 +60,10 @@ single_version_override( ) bazel_dep(name = "score_docs_as_code", version = "2.0.1") -single_version_override( +git_override( # until 2.0.3 or higher is released module_name = "score_docs_as_code", - version = "2.0.1", + remote = "https://github.com/eclipse-score/docs-as-code", + commit = "7e747c91521417c56289eb33b55c33dd1f8e9c77", )