Skip to content

Conversation

@ramceb
Copy link
Contributor

@ramceb ramceb commented Dec 8, 2025

📌 Description

This PR introduces the 2 features:

  1. It moves the sphinx build into bazels execution phase
  2. It introduces a sphinx_docs_library target to support the integration of sphinx_docs from different module to s single documentation

🚨 Impact Analysis

  • This change does not violate any tool requirements and is covered by existing tool requirements
  • This change does not violate any design decisions
  • Otherwise I have created a ticket for new tool qualification

✅ Checklist

  • Added/updated documentation for new or changed features
  • Added/updated tests to cover the changes
  • Followed project coding standards and guidelines

@github-actions
Copy link

github-actions bot commented Dec 8, 2025

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run //src:license-check

Status: ⚠️ Needs Review

Click to expand output
[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.3.0) and connecting to it...
INFO: Invocation ID: a352ef4d-0f62-4b16-a852-639f6557e6f7
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: src
Analyzing: target //src:license-check (1 packages loaded, 0 targets configured)
Analyzing: target //src:license-check (1 packages loaded, 0 targets configured)

Analyzing: target //src:license-check (68 packages loaded, 9 targets configured)

Analyzing: target //src:license-check (123 packages loaded, 2294 targets configured)

Analyzing: target //src:license-check (129 packages loaded, 2435 targets configured)

Analyzing: target //src:license-check (134 packages loaded, 2484 targets configured)

INFO: Analyzed target //src:license-check (137 packages loaded, 4500 targets configured).
[12 / 13] [Prepa] Generating Dash formatted dependency file ...
INFO: Found 1 target...
Target //src:license.check.license_check up-to-date:
  bazel-bin/src/license.check.license_check
  bazel-bin/src/license.check.license_check.jar
INFO: Elapsed time: 11.889s, Critical Path: 0.42s
INFO: 13 processes: 4 disk cache hit, 9 internal.
INFO: Build completed successfully, 13 total actions
INFO: Running command line: bazel-bin/src/license.check.license_check src/formatted.txt <args omitted>
usage: org.eclipse.dash.licenses.cli.Main [-batch <int>] [-cd <url>]
       [-confidence <int>] [-ef <url>] [-excludeSources <sources>] [-help] [-lic
       <url>] [-project <shortname>] [-repo <url>] [-review] [-summary <file>]
       [-timeout <seconds>] [-token <token>]

@github-actions
Copy link

github-actions bot commented Dec 8, 2025

The created documentation from the pull request is available at: docu-html

@ramceb ramceb force-pushed the mb_sphinx_in_execution_phase branch from c27915a to ee9ebc2 Compare December 8, 2025 15:12
ramceb added a commit to eclipse-score/reference_integration that referenced this pull request Dec 8, 2025
This PR shows how a sphinx build can be moved to
the execution phase of bazel builds.

Addditionally, module documentation is now
imported from  `sphinx_docs_library` targets of
dependent modules.

This pr depends on changes in
[PR](eclipse-score/docs-as-code#327)
ramceb added a commit to eclipse-score/reference_integration that referenced this pull request Dec 8, 2025
This PR shows how a sphinx build can be moved to
the execution phase of bazel builds.

Addditionally, module documentation is now
imported from  `sphinx_docs_library` targets of
dependent modules.

This pr depends on changes in
[PR](eclipse-score/docs-as-code#327)
@ramceb ramceb marked this pull request as ready for review December 10, 2025 08:11
docs.bzl Outdated
visibility = ["//visibility:public"],
)

sphinx_docs_library(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand the need for this. Looking at its implementation, it is nearly the same as :docs_sources just with the prefix attribute attached as SphinxDocsLibraryInfo aspect.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The point is the prefix attribute, which make it possible to integrate the tree of rst files into an overall build as shown in the reference integration PR.

name = "sphinx_docs_library",
srcs = [":docs_sources"],
prefix = "docs/modules/x/",
visibility = ["//visibility:public"],
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How are sphinx build not running in execution phase now?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Die sphinx_docs_library as of today does not do anything. It just provides the anchor for the integration on a sphinx_docs target in another integration module. The actual sphinx build happens there. e.g. call bazel build //:html in PR.

optional_options:
safety: "^(QM|ASIL_B)$"
security: "^(YES|NO)$"
optional_options:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This makes safety and security attributes optional again. Seems to be an accidental change?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not an accidential change. I tried to pull in several (all) other modules in PR.
The build broke as many documents did not adopt this change yet.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the newest platform version these are fixed. With eclipse-score/reference_integration#43 it will be fixed here.

@ramceb ramceb force-pushed the mb_sphinx_in_execution_phase branch 5 times, most recently from 21756e3 to 9cba7b2 Compare December 10, 2025 13:24
@ramceb ramceb changed the title Enable sphinx build in bazels execution phase Change docs_sources to spinx_docs_library Dec 10, 2025
@ramceb ramceb force-pushed the mb_sphinx_in_execution_phase branch 2 times, most recently from 2d1c5a0 to a18e7a9 Compare December 10, 2025 15:11
@ramceb ramceb force-pushed the mb_sphinx_in_execution_phase branch from a18e7a9 to f6d4156 Compare December 12, 2025 12:28
@ramceb ramceb closed this Dec 18, 2025
@github-project-automation github-project-automation bot moved this from Draft to Done in Infrastructure Dec 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants