docs: fix mount cross-reference in time detailed design - #229
Merged
Merged
Conversation
License Check Results🚀 The license check job ran with the Bazel command: bazel run //:license-checkStatus: Click to expand output |
The absolute :doc: reference to /module/manuals/user_manual resolves against the combined-site source root once this bundle is mounted into a consumer's aggregated docs build (e.g. reference_integration), not against this bundle's own mount subtree, causing a "WARNING: unknown document" build failure (treated as error with -W). Convert it to a relative reference, following the same fix pattern as #224.
antonkri
force-pushed
the
fix/docs-mount-cross-reference-detailed-design
branch
from
September 21, 2026 10:51
c8f8a60 to
4cd610e
Compare
PiotrKorkus
approved these changes
Sep 21, 2026
antonkri
added a commit
to eclipse-score/reference_integration
that referenced
this pull request
Sep 21, 2026
Bump score_time from 9b307d896c77cf85d8ad7097da04a3ef041df005 to 3723ce687e4abc7d6cb4c0efdbbd30455ed7c303 (main), which merges eclipse-score/time#229: fixes the absolute :doc: mount cross-reference in score/time/docs/detailed_design/index.rst that broke reference_integration's combined docs build (WARNING: unknown document: '/module/manuals/user_manual', treated as error with -W). Regenerated bazel_common/score_modules_target_sw.MODULE.bazel via scripts/known_good/update_module_from_known_good.py. MODULE.bazel.lock verified unchanged: 'bazel build --lockfile_mode=error @score_time//:docs_bundle' before and after this bump produces an identical MODULE.bazel.lock (same checksum) and completes successfully - git_override entries are read directly from MODULE.bazel and are not part of the registry-resolved lockfile content.
antonkri
added a commit
to eclipse-score/reference_integration
that referenced
this pull request
Sep 21, 2026
Bump score_time from 9b307d896c77cf85d8ad7097da04a3ef041df005 to 3723ce687e4abc7d6cb4c0efdbbd30455ed7c303 (main), which merges eclipse-score/time#229: fixes the absolute :doc: mount cross-reference in score/time/docs/detailed_design/index.rst that broke reference_integration's combined docs build (WARNING: unknown document: '/module/manuals/user_manual', treated as error with -W). Regenerated bazel_common/score_modules_target_sw.MODULE.bazel via scripts/known_good/update_module_from_known_good.py. MODULE.bazel.lock verified unchanged: 'bazel build --lockfile_mode=error @score_time//:docs_bundle' before and after this bump produces an identical MODULE.bazel.lock (same checksum) and completes successfully - git_override entries are read directly from MODULE.bazel and are not part of the registry-resolved lockfile content.
antonkri
added a commit
to eclipse-score/reference_integration
that referenced
this pull request
Sep 21, 2026
* docs: enable score_time documentation bundle
- known_good.json: drop "docs": false for score_time and bump its
hash to 866479f (upstream moved score_tooling dev targets out of
the root BUILD, fixing a dev_dependency visibility error when the
module is loaded as a docs_bundle from a non-root workspace).
- scripts/known_good/update_module_from_known_good.py: wire up the
previously unused generate_docs_bundles_content() so docs_bundles.bzl
is actually regenerated by the script, as already documented/tested.
- patches/time/001-fix-docs-mount-cross-references.patch: fix two
Sphinx issues in score_time's docs that only surface once mounted
into the combined reference_integration site: a duplicate
"user_manual" label colliding with score_lifecycle's, and absolute
:doc: cross-references that break outside score_time's own site root.
- Regenerated bazel_common/score_modules_target_sw.MODULE.bazel and
bazel_common/docs_bundles.bzl from known_good.json.
Verified with:
bazel run --lockfile_mode=error //:docs_shim -- \
--github_user=eclipse-score --github_repo=reference_integration
which now reports "build succeeded."
* fix(time): un-dev score_time's reference_integration test deps
score_time's newest commit (866479f) added score/time_slave/tests/reference_integration/,
a test tree built specifically for consumption by reference_integration's generic
per-module unit-test sweep (@score_time//score/...). Its BUILD files load() several
Bazel repos that score_time only declares as dev_dependency = True in its own
MODULE.bazel, so once score_time is a non-root module (our case) those repos are
invisible and package loading crashes before any target selection happens -
identical failure mode to the score_tooling issue fixed upstream for the root BUILD.
- patches/time/002-non-dev-reference-integration-test-deps.patch: drop
dev_dependency = True from score_itf, rules_pkg, score_rules_imagefs and
nlohmann_json bazel_deps (plus the standalone dev_dependency flag on the
json_schema_validator http_archive, which needs nlohmann_json to load its own
BUILD file). The imagefs/oci module extensions themselves stay dev_dependency -
we only need the repos visible for load(), not their toolchain machinery.
- patches/time/003-disable-broken-qnx-ifs-target.patch: the qnx_ifs target in
score/time_slave/tests/reference_integration/qnx/BUILD still fails even once its
repo is visible - its declared score_rules_imagefs 0.0.3 doesn't have the
extra_build_files attribute the target uses. Since it's a QNX image-filesystem
build we don't need for reference_integration's tests, remove the target (and
its now-unused load) rather than chase a version bump.
- known_good.json: register both new patches for score_time.
- Regenerated bazel_common/score_modules_target_sw.MODULE.bazel.
Verified by overlaying the three patches (applied via GNU patch, matching Bazel's
ctx.patch()) onto a pristine shallow clone of score_time@866479f, then swapping
that into the fetched @score_time+ external repo and re-running
`bazel query/build "@score_time//score/..."` - no more package-loading or
analysis errors.
* Update score_time to latest known-good hash
Bump score_time from 866479f654292155fbfef488fa02c089f3e5d8e1 to
9b307d896c77cf85d8ad7097da04a3ef041df005 (main).
Remove two now-obsolete patches, both superseded by upstream PRs opened
during PR #348 review:
- 001-fix-docs-mount-cross-references.patch: merged upstream via
eclipse-score/time#224 (verified via patch --dry-run: "Reversed (or
previously applied) patch detected").
- 002-non-dev-reference-integration-test-deps.patch: merged upstream via
eclipse-score/time#225. dry-run reports hunk failures (not "reversed")
because upstream reformatted surrounding blank lines, but manual
inspection of MODULE.bazel at the new hash confirms every
dev_dependency = True removal from the patch is already present.
003-disable-broken-qnx-ifs-target.patch is kept: it fixes an independent
version conflict between reference_integration's own pinned
score_rules_imagefs 0.0.1 override and score_time's test target, unrelated
to #224/#225, and still applies cleanly.
Verified with 'bazel query @score_time//score/...' (the actual
code_root_path subtree) and 'bazel build @score_time//score/ts_client:docs_bundle'.
Regenerated bazel_common/score_modules_target_sw.MODULE.bazel via
scripts/known_good/update_module_from_known_good.py. MODULE.bazel.lock
needs no update: git_override entries are read directly from MODULE.bazel
and are not part of the registry-resolved lockfile content.
* Update score_time to latest known-good hash
Bump score_time from 9b307d896c77cf85d8ad7097da04a3ef041df005 to
3723ce687e4abc7d6cb4c0efdbbd30455ed7c303 (main), which merges
eclipse-score/time#229: fixes the absolute :doc: mount cross-reference
in score/time/docs/detailed_design/index.rst that broke
reference_integration's combined docs build (WARNING: unknown document:
'/module/manuals/user_manual', treated as error with -W).
Regenerated bazel_common/score_modules_target_sw.MODULE.bazel via
scripts/known_good/update_module_from_known_good.py.
MODULE.bazel.lock verified unchanged: 'bazel build --lockfile_mode=error
@score_time//:docs_bundle' before and after this bump produces an
identical MODULE.bazel.lock (same checksum) and completes successfully -
git_override entries are read directly from MODULE.bazel and are not
part of the registry-resolved lockfile content.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The absolute
:doc:reference to/module/manuals/user_manualinscore/time/docs/detailed_design/index.rstresolves against the combined-site source root once this bundle is mounted into a consumer's aggregated docs build (e.g.reference_integration), not against this bundle's own mount subtree. This causes aWARNING: unknown document: '/module/manuals/user_manual' [ref.doc]build failure (treated as error with-W) in reference_integration's CI.Converts it to a relative reference, following the same fix pattern as #224.
Discovered while updating reference_integration to this module's latest known-good hash (eclipse-score/reference_integration#348).