Initial cleanup (#5)

* Renamed vars for readability
* small improvements and cleanup
* Moving of BUILD files
* Moving string_links option
* Formatting

Preparation commit to move all py_libraries to their own BUILD files.
This solution at the moment is WIP as the pre-fix needed is unacceptable.
But this will serve as a base to be able to test if further changes work

Moved BUILD files to separate folders for better Separation
Cleaned up some smaller stuff
Conf.py is cleaner again

Author: MaximilianSoerenPollak

docs.bzl

@@ -42,11 +42,16 @@ load("@pip_process//:requirements.bzl", "all_requirements", "requirement")
 load("@rules_python//sphinxdocs:sphinx.bzl", "sphinx_build_binary", "sphinx_docs")
 load("@rules_python//sphinxdocs:sphinx_docs_library.bzl", "sphinx_docs_library")
 load("@score_python_basics//:defs.bzl", "score_virtualenv")
-load("//src/extensions:score_source_code_linker/collect_source_files.bzl", "parse_source_files_for_needs_links")
+load("//src/extensions/score_source_code_linker:collect_source_files.bzl", "parse_source_files_for_needs_links")
 
 sphinx_requirements = all_requirements + [
     "//src:plantuml_for_python",
-    "//src/extensions:score_extensions",
+    "//src/extensions:score_plantuml",
+    "//src/extensions/score_draw_uml_funcs:score_draw_uml_funcs",
+    "//src/extensions/score_header_service:score_header_service",
+    "//src/extensions/score_layout:score_layout",
+    "//src/extensions/score_metamodel:score_metamodel",
+    "//src/extensions/score_source_code_linker:score_source_code_linker",
 ]
 
 def docs(source_files_to_scan_for_needs_links = None, source_dir = "docs", conf_dir = "docs", build_dir_for_incremental = "_build", docs_targets = []):
@@ -56,6 +61,11 @@ def docs(source_files_to_scan_for_needs_links = None, source_dir = "docs", conf_
     Current restrictions:
     * only callable from 'docs/BUILD'
     """
+    sphinx_build_binary(
+        name = "sphinx_build",
+        visibility = ["//visibility:public"],
+        deps = sphinx_requirements,
+    )
 
     # Parse source files for needs links
     # This needs to be created to generate a target, otherwise it won't execute as dependency for other macros
@@ -64,7 +74,8 @@ def docs(source_files_to_scan_for_needs_links = None, source_dir = "docs", conf_
         srcs_and_deps = source_files_to_scan_for_needs_links if source_files_to_scan_for_needs_links else [],
     )
 
-    # TODO: Explain what this does / how it works?
+    # We are iterating over all provided 'targets' in order to allow for automatic generation of them without
+    # needing to modify the underlying 'docs.bzl' file.
     for target in docs_targets:
         suffix = "_" + target["suffix"] if target["suffix"] else ""
         external_needs_deps = target.get("target", [])
@@ -105,12 +116,12 @@ def _incremental(incremental_name = "incremental", live_name = "live_preview", s
         extra_dependencies: Additional dependencies besides the centrally maintained "sphinx_requirements".
     """
 
-    dependencies = sphinx_requirements + extra_dependencies
+    dependencies = sphinx_requirements + extra_dependencies + ["@rules_python//python/runfiles"]
     py_binary(
         name = incremental_name,
         srcs = ["//src:incremental.py"],
         deps = dependencies,
-        data = [":score_source_code_parser"] + external_needs_deps,
+        data = [":score_source_code_parser"] + dependencies,
         env = {
             "SOURCE_DIRECTORY": source_dir,
             "CONF_DIRECTORY": conf_dir,
@@ -144,7 +155,6 @@ def _ide_support():
 def _docs(name = "docs", format = "html", external_needs_deps = list(), external_needs_def = dict()):
     ext_needs_arg = "--define=external_needs_source=" + json.encode(external_needs_def)
 
-    #fail(ext_needs_arg)
     sphinx_docs(
         name = name,
         srcs = native.glob([
@@ -157,7 +167,6 @@ def _docs(name = "docs", format = "html", external_needs_deps = list(), external
             "**/*.need",
             # Include the docs src itself
             # Note: we don't use py_library here to make it as close as possible to docs:incremental.
-            "**/*.py",
             "**/*.yaml",
             "**/*.json",
             "**/*.csv",
@@ -170,7 +179,7 @@ def _docs(name = "docs", format = "html", external_needs_deps = list(), external
         formats = [
             format,
         ],
-        sphinx = "//src:sphinx_build",
+        sphinx = ":sphinx_build",
         tags = [
             "manual",
         ],

process-docs/BUILD

@@ -25,49 +25,38 @@ docs(
         {
             "suffix": "",  # local without external needs
         },
-
-        #           ╭───────────────────────────────────────╮
-        #           │   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",
-        #         },
-        #     ],
-        # },
-        # {
-        #     "suffix": "latest",  # latest main branch documentation build
-        #     "external_needs_info": [
-        #         {
-        #             "base_url": "https://eclipse-score.github.io/score/main/",
-        #             "json_url": "https://maximiliansoerenpollak.github.io/score/needs.json",
-        #             "version": "0.1",
-        #         },
-        #     ],
-        # },
     ],
     source_dir = "process-docs",
     source_files_to_scan_for_needs_links = [
         # Note: you can add filegroups, globs, or entire targets here.
-        "//src/extensions:score_extensions",
-        ":score_extensions",
-        ":score_source_code_linker",
+        "//src:score_extension_files",
+        "//src:plantuml_for_python",
     ],
 )
 
-py_library(
-    name = "score_source_code_linker",
-    srcs = glob(
-        ["src/extensions/score_source_code_linker/**/*.py"],
-        exclude = ["src/extensions/score_source_code_linker/tests/*.py"],
-    ),
-    imports = ["src/extensions"],
-    visibility = ["//visibility:public"],
-)
+#           ╭───────────────────────────────────────╮
+#           │   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",
+#         },
+#     ],
+# },
+# {
+#     "suffix": "latest",  # latest main branch documentation build
+#     "external_needs_info": [
+#         {
+#             "base_url": "https://eclipse-score.github.io/score/main/",
+#             "json_url": "https://maximiliansoerenpollak.github.io/score/needs.json",
+#             "version": "0.1",
+#         },
+#     ],
+# },

process-docs/conf.py

@@ -32,6 +32,7 @@
 logger = logging.getLogger("process-docs")
 logger.debug("Loading docs-as-code conf.py")
 
+
 extensions = [
     "sphinx_design",
     "sphinx_needs",
@@ -42,6 +43,7 @@
     "score_source_code_linker",
     "score_layout",
 ]
+
 logger.debug("After loading extensions")
 
 exclude_patterns = [
@@ -58,19 +60,6 @@
 # Enable numref
 numfig = True
 
-
-# -- sphinx-needs configuration --------------------------------------------
-# Setting the needs layouts
-needs_global_options = {"collapse": True}
-needs_string_links = {
-    "source_code_linker": {
-        "regex": r"(?P<value>[^,]+)",
-        "link_url": "{{value}}",
-        "link_name": "Source Code Link",
-        "options": ["source_code_link"],
-    },
-}
-
 # TODO: Fixing this in all builds
 html_static_path = ["../src/assets"]
 

pyproject.toml

@@ -3,5 +3,19 @@
 [tool.pyright] 
 extends = "bazel-bin/process-docs/ide_support.runfiles/score_python_basics~/pyproject.toml"
 
+exclude = [
+    "**/__pycache__",
+    "**/.*",
+    "**/bazel-*",
+    "venv/**",
+]
+
 [tool.ruff]
 extend = "bazel-bin/process-docs/ide_support.runfiles/score_python_basics~/pyproject.toml"
+
+extend-exclude = [
+    "**/__pycache__",
+    "/.*",
+    "bazel-*",
+    "venv/**",
+]

src/BUILD

@@ -20,24 +20,15 @@ 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")
 
-sphinx_requirements = all_requirements + [
-    ":plantuml_for_python",
-    "//src/extensions:score_extensions",
-]
-
-sphinx_build_binary(
-    name = "sphinx_build",
-    visibility = ["//visibility:public"],
-    deps = sphinx_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.
+
 exports_files(
     [
         "requirements.txt",
         "incremental.py",
+        "dummy.py",
     ],
     visibility = ["//visibility:public"],
 )
@@ -98,6 +89,19 @@ py_library(
     visibility = ["//visibility:public"],
 )
 
+filegroup(
+    name = "score_extension_files",
+    srcs = glob(
+        ["*/**"],
+        exclude = [
+            "**/test/**",
+            "**/tests/**",
+            "**/__pycache__/**",
+        ],
+    ),
+    visibility = ["//visibility:public"],
+)
+
 # Running this executes the `collect_source_files.bzl` aspect.
 # Collects all source files from specified targets in 'deps', and makes them available for parsing for the source_code_linker
 

src/extensions/BUILD

@@ -15,74 +15,15 @@ load("@aspect_rules_py//py:defs.bzl", "py_binary", "py_library")
 load("@pip_process//:requirements.bzl", "all_requirements")
 load("@score_python_basics//:defs.bzl", "score_py_pytest", "score_virtualenv")
 
-score_virtualenv(
-    name = "process_venv",
-    reqs = all_requirements,
-    venv_name = ".venv_process",
-)
-
-py_library(
-    name = "score_extensions",
-    srcs = glob(
-        ["**/*.py"],
-        exclude = ["**/tests/**/*"],
-    ),
-    data = glob([
-        "score_layout/assets/**",
-        "score_metamodel/*.yaml",  # Needed to remove 'resolving of symlink' in score_metamodel.__init__
-    ]),
-    imports = ["."],
-    visibility = ["//visibility:public"],
-    deps = [
-        "@rules_python//python/runfiles",
-    ],
-)
+# TODO: This probably can be deleted
+# score_virtualenv(
+#     name = "process_venv",
+#     reqs = all_requirements,
+#     venv_name = ".venv_process",
+# )
 
-# Dedicated metamodel target only for pytest.
-# It's required to define the imports for bazel pytest, so that python/pytest can
-# import "from score_metamodel" without issues.
 py_library(
-    name = "score_metamodel",
-    srcs = glob(
-        ["score_metamodel/**/*.py"],
-        exclude = ["**/tests/**/*"],
-    ),
-    imports = ["extensions"],
-    visibility = ["//visibility:public"],
-)
-
-score_py_pytest(
-    name = "score_metamodel_test",
-    size = "small",
-    srcs = glob(["score_metamodel/tests/**/*.py"]),
-    visibility = ["//visibility:public"],
-    deps = [":score_metamodel"] + all_requirements,
-)
-
-# ───────────────────────── Source code linker ────────────────────────
-# For more information see documentation at score_source_code_linker/README.md
-py_library(
-    name = "score_source_code_linker",
-    srcs = glob(
-        ["score_source_code_linker/**/*.py"],
-        exclude = ["score_source_code_linker/tests/*.py"],
-    ),
-    imports = ["."],
-    visibility = ["//visibility:public"],
-)
-
-score_py_pytest(
-    name = "score_source_code_linker_test",
-    size = "small",
-    srcs = glob(["score_source_code_linker/tests/**/*.py"]),
-    deps = [
-        ":score_source_code_linker",
-    ] + all_requirements,
-)
-
-# Needed to make the file parser executeable and findable for the source_code_linker aspect
-py_binary(
-    name = "parsed_source_files_for_source_code_linker",
-    srcs = ["score_source_code_linker/parse_source_files.py"],
+    name = "score_plantuml",
+    srcs = ["score_plantuml.py"],
     visibility = ["//visibility:public"],
 )

src/extensions/score_draw_uml_funcs/BUILD

@@ -0,0 +1,25 @@
+# *******************************************************************************
+# Copyright (c) 2025 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("@pip_process//:requirements.bzl", "all_requirements")
+
+py_library(
+    name = "score_draw_uml_funcs",
+    srcs = glob(
+        ["*.py"],
+    ),
+    imports = ["."],
+    visibility = ["//visibility:public"],
+    # TODO: Figure out if all requirements are needed or if we can break it down a bit
+    deps = all_requirements,
+)