Merge branch 'main' into Aymen-Soussi-01-fix-and-remove-gitlint-action-file

Author: Aymen-Soussi-01

.github/workflows/format.yml

@@ -27,4 +27,5 @@ jobs:
         uses: bazel-contrib/setup-bazel@0.9.1
       - name: Run formatting checks
         run: |
+          bazel run //src:ide_support
           bazel test //src:format.check

.github/workflows/license_check.yml

@@ -28,5 +28,6 @@ jobs:
     uses: eclipse-score/cicd-workflows/.github/workflows/license-check.yml@main
     with:
       repo-url: "${{ github.server_url }}/${{ github.repository }}"
+      bazel-target: "run //src:license-check"
     secrets:
       dash-api-token: ${{ secrets.ECLIPSE_GITLAB_API_TOKEN }}

.github/workflows/test.yml

@@ -23,4 +23,5 @@ jobs:
         uses: actions/checkout@v4.2.2
       - name: Run test targets
         run: |
+          bazel run //src:ide_support
           bazel test ...

MODULE.bazel

@@ -13,7 +13,7 @@
 
 module(
     name = "score_docs_as_code",
-    version = "0.2.0",
+    version = "0.2.1",
     compatibility_level = 0,
 )
 

docs.bzl

@@ -38,11 +38,11 @@
 # For user-facing documentation, refer to `/README.md`.
 
 load("@aspect_rules_py//py:defs.bzl", "py_binary", "py_library")
-load("@score_docs_as_code//src/extensions/score_source_code_linker:collect_source_files.bzl", "parse_source_files_for_needs_links")
 load("@pip_process//:requirements.bzl", "all_requirements", "requirement")
 load("@rules_java//java:java_binary.bzl", "java_binary")
 load("@rules_python//sphinxdocs:sphinx.bzl", "sphinx_build_binary", "sphinx_docs")
 load("@rules_python//sphinxdocs:sphinx_docs_library.bzl", "sphinx_docs_library")
+load("@score_docs_as_code//src/extensions/score_source_code_linker:collect_source_files.bzl", "parse_source_files_for_needs_links")
 load("@score_python_basics//:defs.bzl", "score_virtualenv")
 
 sphinx_requirements = all_requirements + [
@@ -158,7 +158,7 @@ def _ide_support():
         reqs = sphinx_requirements,
     )
 
-def _docs(name = "docs", format = "html", external_needs_deps = list(), external_needs_def = dict()):
+def _docs(name = "docs", format = "html", external_needs_deps = list(), external_needs_def = list()):
     ext_needs_arg = "--define=external_needs_source=" + json.encode(external_needs_def)
 
     sphinx_docs(

docs/BUILD

@@ -0,0 +1,60 @@
+# *******************************************************************************
+# Copyright (c) 2024 Contributors to the Eclipse Foundation
+#
+# See the NOTICE file(s) distributed with this work for additional
+# information regarding copyright ownership.
+#
+# This program and the accompanying materials are made available under the
+# terms of the Apache License Version 2.0 which is available at
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# SPDX-License-Identifier: Apache-2.0
+# *******************************************************************************
+
+load("@aspect_rules_py//py:defs.bzl", "py_library")
+load("//:docs.bzl", "docs")
+
+# Creates all documentation targets:
+# - `docs:incremental` for building docs incrementally at runtime
+# - `docs:live_preview` for live preview in the browser without an IDE
+# - `docs:ide_support` for creating python virtualenv for IDE support
+# - `docs:docs` for building documentation at build-time
+
+docs(
+    conf_dir = "docs",
+    docs_targets = [
+        {
+            "suffix": "latest",  # latest main branch documentation build
+            "external_needs_info": [
+                {
+                    "base_url": "https://eclipse-score.github.io/score/main/",
+                    "json_url": "https://eclipse-score.github.io/score/main/needs.json",
+                    "version": "0.1",
+                    "id_prefix": "score_",
+                },
+            ],
+        },
+    ],
+    source_dir = "docs",
+    source_files_to_scan_for_needs_links = [
+        # Note: you can add filegroups, globs, or entire targets here.
+        "//src:score_extension_files",
+    ],
+)
+
+#           ╭───────────────────────────────────────╮
+#           │   This is commented out until local   │
+#           │   multi-repo testing is implemented   │
+#           ╰───────────────────────────────────────╯
+
+# {
+#     "suffix": "release",  # The version imported from MODULE.bazel
+#     "target": ["@score_platform//docs:docs"],
+#     "external_needs_info": [
+#         {
+#             "base_url": "https://eclipse-score.github.io/score/pr-980/",
+#             "json_path": "/score_platform~/docs/docs/_build/html/needs.json",
+#             "version": "0.1",
+#         },
+#     ],
+# },

docs/conf.py

@@ -0,0 +1,54 @@
+# *******************************************************************************
+# Copyright (c) 2024 Contributors to the Eclipse Foundation
+#
+# See the NOTICE file(s) distributed with this work for additional
+# information regarding copyright ownership.
+#
+# This program and the accompanying materials are made available under the
+# terms of the Apache License Version 2.0 which is available at
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# SPDX-License-Identifier: Apache-2.0
+# *******************************************************************************
+
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "Simple Example Project"
+author = "S-CORE"
+version = "0.1"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+
+extensions = [
+    "sphinx_design",
+    "sphinx_needs",
+    "sphinxcontrib.plantuml",
+    "score_plantuml",
+    "score_metamodel",
+    "score_draw_uml_funcs",
+    "score_source_code_linker",
+    "score_layout",
+]
+
+exclude_patterns = [
+    # The following entries are not required when building the documentation via 'bazel
+    # build //docs:docs', as that command runs in a sandboxed environment. However, when
+    # building the documentation via 'bazel run //docs:incremental' or esbonio, these
+    # entries are required to prevent the build from failing.
+    "bazel-*",
+    ".venv_docs",
+]
+
+templates_path = ["templates"]
+
+# Enable numref
+numfig = True

docs/index.rst

@@ -0,0 +1,29 @@
+..
+   # *******************************************************************************
+   # Copyright (c) 2024 Contributors to the Eclipse Foundation
+   #
+   # See the NOTICE file(s) distributed with this work for additional
+   # information regarding copyright ownership.
+   #
+   # This program and the accompanying materials are made available under the
+   # terms of the Apache License Version 2.0 which is available at
+   # https://www.apache.org/licenses/LICENSE-2.0
+   #
+   # SPDX-License-Identifier: Apache-2.0
+   # *******************************************************************************
+
+Hello World
+=================
+This is a simple example of a documentation page using the `docs` tool.
+
+.. stkh_req:: TestTitle
+   :id: stkh_req__test_requirement
+   :status: valid
+   :safety: QM
+   :rationale: A simple requirement we need to enable a documentation build
+   :reqtype: Functional
+
+   Some content to make sure we also can render this
+   This is a link to an external need inside the 'score' documentation
+   :need:`SCORE_gd_req__req__attr_safety`
+

pyproject.toml

@@ -1,7 +1,7 @@
 # This file is at the root level, as it applies to all Python code,
 # not only to docs or to tools.
 [tool.pyright]
-extends = "bazel-bin/examples/simple/ide_support.runfiles/score_python_basics~/pyproject.toml"
+extends = "bazel-bin/src/ide_support.runfiles/score_python_basics~/pyproject.toml"
 
 exclude = [
     "**/__pycache__",
@@ -11,7 +11,7 @@ exclude = [
 ]
 
 [tool.ruff]
-extend = "bazel-bin/examples/simple/ide_support.runfiles/score_python_basics~/pyproject.toml"
+extend = "bazel-bin/src/ide_support.runfiles/score_python_basics~/pyproject.toml"
 
 extend-exclude = [
     "**/__pycache__",

src/BUILD

@@ -10,7 +10,6 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 # *******************************************************************************
-
 load("@aspect_rules_lint//format:defs.bzl", "format_multirun", "format_test")
 load("@aspect_rules_py//py:defs.bzl", "py_binary", "py_library")
 load("@pip_process//:requirements.bzl", "all_requirements", "requirement")
@@ -19,7 +18,20 @@ load("@rules_pkg//pkg:tar.bzl", "pkg_tar")
 load("@rules_python//python:pip.bzl", "compile_pip_requirements")
 load("@rules_python//sphinxdocs:sphinx.bzl", "sphinx_build_binary")
 load("@score_dash_license_checker//:dash.bzl", "dash_license_checker")
-
+load("@score_python_basics//:defs.bzl", "score_virtualenv")
+
+score_virtualenv(
+    reqs = [
+        "@score_docs_as_code//src:plantuml_for_python",
+        "@score_docs_as_code//src/extensions:score_plantuml",
+        "@score_docs_as_code//src/find_runfiles:find_runfiles",
+        "@score_docs_as_code//src/extensions/score_draw_uml_funcs:score_draw_uml_funcs",
+        "@score_docs_as_code//src/extensions/score_header_service:score_header_service",
+        "@score_docs_as_code//src/extensions/score_layout:score_layout",
+        "@score_docs_as_code//src/extensions/score_metamodel:score_metamodel",
+        "@score_docs_as_code//src/extensions/score_source_code_linker:score_source_code_linker",
+    ] + all_requirements,
+)
 # These are only exported because they're passed as files to the //docs.bzl
 # macros, and thus must be visible to other packages. They should only be
 # referenced by the //docs.bzl macros.
@@ -135,7 +147,7 @@ filegroup(
 
 dash_license_checker(
     src = ":requirements_lock",
-    file_type = "requirements",  # let it auto-detect based on project_config
+    file_type = "requirements",
     visibility = ["//visibility:public"],
 )