Skip to content

Add sphinx_module support#366

Merged
AlexanderLanin merged 4 commits intomainfrom
mb_sphinx_in_execution_phase
Feb 5, 2026
Merged

Add sphinx_module support#366
AlexanderLanin merged 4 commits intomainfrom
mb_sphinx_in_execution_phase

Conversation

@ramceb
Copy link
Contributor

@ramceb ramceb commented Jan 26, 2026

📌 Description

🚨 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 Jan 26, 2026

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: a46af36e-ef6e-43c7-9f4a-c75a8e264f56
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: src
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 (57 packages loaded, 9 targets configured)

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

Analyzing: target //src:license-check (119 packages loaded, 435 targets configured)

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

Analyzing: target //src:license-check (140 packages loaded, 2576 targets configured)

Analyzing: target //src:license-check (140 packages loaded, 2576 targets configured)

Analyzing: target //src:license-check (144 packages loaded, 3097 targets configured)

INFO: Analyzed target //src:license-check (145 packages loaded, 4715 targets configured).
[12 / 16] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes; 0s disk-cache, processwrapper-sandbox ... (2 actions, 1 running)
[15 / 16] [Prepa] Building src/license.check.license_check.jar ()
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: 21.759s, Critical Path: 2.48s
INFO: 16 processes: 12 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 16 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>]

@ramceb ramceb force-pushed the mb_sphinx_in_execution_phase branch from 10334d0 to e028ba1 Compare January 26, 2026 17:19
@github-actions
Copy link

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

@ramceb ramceb force-pushed the mb_sphinx_in_execution_phase branch 2 times, most recently from f2d8490 to 5af3382 Compare January 26, 2026 22:02
@ramceb ramceb force-pushed the mb_sphinx_in_execution_phase branch 3 times, most recently from 718388b to 37594b3 Compare February 3, 2026 10:50
@ramceb ramceb force-pushed the mb_sphinx_in_execution_phase branch from 37594b3 to f6a6196 Compare February 4, 2026 13:04
@AlexanderLanin
Copy link
Member

AlexanderLanin commented Feb 4, 2026

@ramceb can you use rules_python instead of score_tooling here?

https://rules-python.readthedocs.io/en/latest/api/sphinxdocs/sphinxdocs/sphinx_docs_library.html

@ramceb ramceb force-pushed the mb_sphinx_in_execution_phase branch from f6a6196 to 91f5186 Compare February 4, 2026 16:24
@ramceb ramceb changed the title Change docs_sources to spinx_docs_library Add sphinx_module support Feb 4, 2026
@ramceb ramceb force-pushed the mb_sphinx_in_execution_phase branch from 91f5186 to 83a72b9 Compare February 4, 2026 16:41
@hoe-jo hoe-jo marked this pull request as ready for review February 5, 2026 12:45
$(SRCS)
""",
tools = ["@score_docs_as_code//scripts_bazel:generate_sourcelinks"],
visibility = ["//visibility:public"],
Copy link
Member

Choose a reason for hiding this comment

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

AFAIK this must be public. I also dont understand the comment in the next line. Looks like a merge problem?

Copy link
Contributor

Choose a reason for hiding this comment

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

fixed

load("@rules_pkg//pkg:mappings.bzl", "pkg_files", "strip_prefix")
load("@rules_python//sphinxdocs:sphinx.bzl", "sphinx_build_binary", "sphinx_docs")
load("@score_tooling//:defs.bzl", "score_virtualenv")
load("@score_tooling//bazel/rules/rules_score:rules_score.bzl", "sphinx_module")
Copy link
Contributor

@MaximilianSoerenPollak MaximilianSoerenPollak Feb 5, 2026

Choose a reason for hiding this comment

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

What is the reason of bringing this in?

Trying to understand why we need/should use this?
Will this be compatible with every consumer / downstream?

Copy link
Contributor

Choose a reason for hiding this comment

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

It is not breaking anything up to now. So yes it is compatible. And in the process group there was a discussion that we will start a poc for persistency:
https://github.com/orgs/eclipse-score/discussions/407#discussioncomment-15605348

Copy link
Member

Choose a reason for hiding this comment

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

To my understanding this is POC development performed by BMW, which we can basically merge as long as it doesn't break the productive docs build. Currently it lacks features in comparison to the current build setup, so it's too early to even discuss which is "better".

We need to be careful to not confuse docs users or management expectations.

@hoe-jo hoe-jo force-pushed the mb_sphinx_in_execution_phase branch from 7b9394e to 10d63bb Compare February 5, 2026 13:43
@AlexanderLanin
Copy link
Member

discussed and agreed to merge

@AlexanderLanin AlexanderLanin merged commit 33da431 into main Feb 5, 2026
11 of 13 checks passed
@AlexanderLanin AlexanderLanin deleted the mb_sphinx_in_execution_phase branch February 5, 2026 16:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

4 participants