Example how to use the module api

BUILD

@@ -10,12 +10,43 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 # *******************************************************************************
-
 load("@score_docs_as_code//:docs.bzl", "docs")
 
+load("@rules_python//sphinxdocs:sphinx.bzl", "sphinx_build_binary", "sphinx_docs")
+load("@rules_python//sphinxdocs:sphinx_docs_library.bzl", "sphinx_docs_library")
+load("@score_tooling//bazel/rules/score_module:score_module.bzl", "safety_element_out_of_context")
+
 docs(
     data = [
-       "@score_process//:needs_json",
+       # "@score_process//:needs_json",
     ],
     source_dir = "docs",
 )
+
+
+
+sphinx_docs(
+        name = "baselibs.html",
+        srcs = ["//:docs/index.rst"],
+        config = "//:docs/conf.py",
+        extra_opts = [
+            "-W",
+            "--keep-going",
+            "-T",  # show more details in case of errors
+            "--jobs",
+            "auto",
+        ],
+        formats = ["html"],
+        sphinx = ":sphinx_build",
+        tools = [],
+        visibility = ["//visibility:public"],
+        # Modules export their docs as sphinx_docs_library
+        # which are imported by bazel to docs/modules/<module_name>
+        deps = [
+            "//score/concurrency:seooc_concurrency"    
+        ],
+    )
+
+
+
+

MODULE.bazel

@@ -68,6 +68,12 @@ bazel_dep(name = "score_docs_as_code", version = "2.2.0")
 bazel_dep(name = "score_process", version = "1.4.0")
 bazel_dep(name = "score_tooling", version = "1.0.4")
 
+git_override(
+    module_name = "score_tooling",
+    remote = "https://github.com/eclipse-score/tooling.git",
+    commit = "ae857267a9f2e9f2e6505f8547d86f0eff1fed5b",
+)
+
 ## Configure the python toolchain
 
 bazel_dep(name = "rules_python", version = "1.4.1")

docs/index.rst

@@ -32,5 +32,11 @@ Summary
 
 **Type:** C++ Base Libraries
 
+.. toctree::
+   :maxdepth: 2
+   :glob:
+   :caption: Modules
+
+   safety_elements/**/index
 
 

score/concurrency/BUILD

@@ -13,6 +13,10 @@
 
 load("@score_baselibs//:bazel/unit_tests.bzl", "cc_gtest_unit_test", "cc_unit_test_suites_for_host_and_qnx")
 load("@score_baselibs//score/language/safecpp:toolchain_features.bzl", "COMPILER_WARNING_FEATURES")
+load("@score_tooling//bazel/rules/score_module:score_module.bzl", "safety_element_out_of_context")
+
+load("@rules_python//sphinxdocs:sphinx_docs_library.bzl", "sphinx_docs_library")
+
 
 cc_library(
     name = "clock",
@@ -467,3 +471,71 @@ cc_unit_test_suites_for_host_and_qnx(
         "//visibility:public",
     ],
 )
+
+
+# ############################################################
+# SAFETY ELEMENT OUT OF CONTEXT
+# ############################################################
+sphinx_docs_library(
+    name = "assumptions_of_use",
+    srcs = ["design/assumptions_of_use.md"],
+)
+
+sphinx_docs_library(
+    name = "component_requirements",
+    srcs = ["design/component_requirements.md"],
+)
+
+sphinx_docs_library(
+    name = "architectural_design",
+    srcs = ["design/architectural_design.md"],
+)
+
+sphinx_docs_library(
+    name = "safety_analysis",
+    srcs = ["design/safety_analysis.md"],
+)
+
+safety_element_out_of_context(
+    name = "seooc_concurrency",
+    architectural_design = ":architectural_design",
+    assumptions_of_use = ":assumptions_of_use",
+    component_requirements = ":component_requirements",
+    implementations = [
+        "//score/concurrency:clock",
+        "//score/concurrency:concurrency",
+        "//score/concurrency:condition_variable",
+        "//score/concurrency:delayed_task",
+        "//score/concurrency:destruction_guard",
+        "//score/concurrency:executor",
+        "//score/concurrency:executor_mock",
+        "//score/concurrency/future:future",
+        "//score/concurrency/future:test_types",
+        "//score/concurrency:interruptible_conditional_variable_mock",
+        "//score/concurrency:interruptible_interprocess_condition_variable",
+        "//score/concurrency:interruptible_wait",
+        "//score/concurrency:long_running_threads_container",
+        "//score/concurrency:notification",
+        "//score/concurrency:periodic_task",
+        "//score/concurrency:shared_task_result",
+        "//score/concurrency:synchronized_queue",
+        "//score/concurrency:task_result",
+        "//score/concurrency:task_result_base",
+        "//score/concurrency/thread_load_tracking:thread_load_tracking",
+        "//score/concurrency:thread_pool",
+        "//score/concurrency/timed_executor:concurrent_timed_executor",
+        "//score/concurrency/timed_executor:delayed_task",
+        "//score/concurrency/timed_executor:periodic_task",
+        "//score/concurrency/timed_executor:timed_executor",
+        "//score/concurrency/timed_executor:timed_executor_mock",
+        "//score/concurrency/timed_executor:timed_task",
+    ],
+    safety_analysis = ":safety_analysis",
+    tests = [
+        "//score/concurrency/future:unit_test_suite_host",
+        "//score/concurrency/thread_load_tracking:unit_test_suite_host",
+        "//score/concurrency/timed_executor:unit_test_suite_host",
+        "//score/concurrency:unit_test_suite_host",
+    ],
+    visibility = ["//visibility:public"],
+)

score/concurrency/design/architectural_design.md

@@ -0,0 +1,5 @@
+# Architectural Design
+
+Architectural design documentation for the concurrency module.
+
+(To be completed)

score/concurrency/design/assumptions_of_use.md

@@ -0,0 +1,5 @@
+# Assumptions of Use
+
+Assumptions of use documentation for the concurrency module.
+
+(To be completed)

score/concurrency/design/component_requirements.md

@@ -0,0 +1,5 @@
+# Component Requirements
+
+Component requirements documentation for the concurrency module.
+
+(To be completed)

score/concurrency/design/safety_analysis.md

@@ -0,0 +1,5 @@
+# Safety Analysis
+
+Safety analysis documentation for the concurrency module.
+
+(To be completed)

score/containers/BUILD

@@ -156,3 +156,4 @@ cc_unit_test_suites_for_host_and_qnx(
         "//visibility:public",
     ],
 )
+