Repository navigation
docs: integrate mw::log traceability into Sphinx - #365
Draft
Y-Vaishnavi wants to merge 2 commits into
Draft
Y-Vaishnavi wants to merge 2 commits into
Y-Vaishnavi wants to merge 2 commits into
Conversation
Y-Vaishnavi
requested review from
4og,
antonkri,
arsibo,
hoppe-and-dreams,
pawelrutkaq and
rmaddikery
as code owners
October 19, 2026 13:53
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 19, 2026 13:53 — with
GitHub Actions
Error
Y-Vaishnavi
requested a deployment
to
workflow-approval
October 19, 2026 13:53 — with
GitHub Actions
Waiting
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 19, 2026 13:53 — with
GitHub Actions
Error
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 19, 2026 13:53 — with
GitHub Actions
Error
Y-Vaishnavi
marked this pull request as draft
October 19, 2026 13:53
License Check Results🚀 The license check job ran with the Bazel command: bazel run --lockfile_mode=error //:license-checkStatus: Click to expand output |
Y-Vaishnavi
requested a deployment
to
workflow-approval
October 19, 2026 13:55 — with
GitHub Actions
Waiting
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 19, 2026 13:55 — with
GitHub Actions
Error
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 19, 2026 13:55 — with
GitHub Actions
Error
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 19, 2026 13:55 — with
GitHub Actions
Error
Y-Vaishnavi
force-pushed
the
vy/docs-integrate-mw-log-traceability
branch
from
October 19, 2026 14:00
abd67f5 to
bfa2212
Compare
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 19, 2026 14:00 — with
GitHub Actions
Error
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 19, 2026 14:00 — with
GitHub Actions
Error
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 19, 2026 14:00 — with
GitHub Actions
Error
Y-Vaishnavi
requested a deployment
to
workflow-approval
October 19, 2026 14:00 — with
GitHub Actions
Waiting
Y-Vaishnavi
requested a deployment
to
workflow-approval
October 19, 2026 14:04 — with
GitHub Actions
Waiting
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 19, 2026 14:04 — with
GitHub Actions
Error
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 19, 2026 14:04 — with
GitHub Actions
Error
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 19, 2026 14:04 — with
GitHub Actions
Error
Y-Vaishnavi
force-pushed
the
vy/docs-integrate-mw-log-traceability
branch
from
October 19, 2026 14:14
2d0010d to
bfa2212
Compare
Y-Vaishnavi
requested a deployment
to
workflow-approval
October 19, 2026 14:14 — with
GitHub Actions
Waiting
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 19, 2026 14:14 — with
GitHub Actions
Error
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 19, 2026 14:44 — with
GitHub Actions
Error
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 19, 2026 14:44 — with
GitHub Actions
Error
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 19, 2026 14:44 — with
GitHub Actions
Error
Y-Vaishnavi
force-pushed
the
vy/docs-integrate-mw-log-traceability
branch
from
October 19, 2026 15:53
e1e3bb1 to
5760a33
Compare
Y-Vaishnavi
requested a deployment
to
workflow-approval
October 19, 2026 15:53 — with
GitHub Actions
Waiting
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 19, 2026 15:53 — with
GitHub Actions
Error
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 19, 2026 15:53 — with
GitHub Actions
Error
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 19, 2026 15:53 — with
GitHub Actions
Error
Y-Vaishnavi
force-pushed
the
vy/docs-integrate-mw-log-traceability
branch
from
October 21, 2026 04:45
5760a33 to
f88b7ec
Compare
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 21, 2026 04:45 — with
GitHub Actions
Error
Y-Vaishnavi
requested a deployment
to
workflow-approval
October 21, 2026 04:45 — with
GitHub Actions
Waiting
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 21, 2026 04:45 — with
GitHub Actions
Error
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 21, 2026 04:45 — with
GitHub Actions
Error
Y-Vaishnavi
force-pushed
the
vy/docs-integrate-mw-log-traceability
branch
from
October 21, 2026 07:04
f88b7ec to
a23d620
Compare
Y-Vaishnavi
requested a deployment
to
workflow-approval
October 21, 2026 07:04 — with
GitHub Actions
Waiting
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 21, 2026 07:04 — with
GitHub Actions
Error
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 21, 2026 07:04 — with
GitHub Actions
Error
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 21, 2026 07:04 — with
GitHub Actions
Error
Y-Vaishnavi
force-pushed
the
vy/docs-integrate-mw-log-traceability
branch
from
October 21, 2026 07:11
a23d620 to
6776081
Compare
Y-Vaishnavi
requested a deployment
to
workflow-approval
October 21, 2026 07:11 — with
GitHub Actions
Waiting
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 21, 2026 07:11 — with
GitHub Actions
Error
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 21, 2026 07:11 — with
GitHub Actions
Error
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 21, 2026 07:11 — with
GitHub Actions
Error
Y-Vaishnavi
force-pushed
the
vy/docs-integrate-mw-log-traceability
branch
from
October 21, 2026 07:41
6776081 to
2ce5aef
Compare
Y-Vaishnavi
requested a deployment
to
workflow-approval
October 21, 2026 07:42 — with
GitHub Actions
Waiting
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 21, 2026 07:42 — with
GitHub Actions
Error
Y-Vaishnavi
had a problem deploying
to
workflow-approval
October 21, 2026 07:42 — with
GitHub Actions
Error
rmaddikery
reviewed
Oct 21, 2026
| @@ -0,0 +1,134 @@ | |||
| .. | |||
Contributor
There was a problem hiding this comment.
This is already a duplication of the existing repo structure. This should not be needed
Squashed stack that adds the mw::log dependability prerequisites and wires the generated traceability report into the main Sphinx site.
CI currently publishes //:docs (the docs() macro tree), which has no mechanism to pull in the generated mw::log dependable-element/LOBSTER traceability report - only //docs/sphinx:sphinx_doc embeds that content via docs_library_deps. As a result the report would never appear on the published GitHub Pages site even after merge. Add a build_sphinx_package py_binary that copies sphinx_doc's bazel-bin output into _build/, the directory the shared cicd-workflows docs.yml uploads as the github-pages artifact, and point the build-docs job at it instead of //:docs. The docs_check (verify-only) job is unaffected. Signed-off-by: vaishnavi yendole <vaishnavi.yendole@bti.bmwgroup.com>
This branch is waiting to be deployed
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
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.
Summary
//docs/sphinx:sphinx_doc)docs/index.rst)//:docs_checkpassing alongside this changeDetails
The traceability report was already being generated, but it wasn't linked from anywhere in the Sphinx documentation. This change:
//docs/sphinx:sphinx_docvia its_rstfacade, and embeds it in that build's sidebar toctreedocs/index.rst)Note:
//docs/sphinx:sphinx_docis a local-preview-only target — it isn't built/published by.github/workflows/docs.yml(only//:docsis). The "Safety Reports" link indocs/index.rstcurrently points at a path that isn't produced by the//:docsbuild either, so it won't resolve on the live site yet; making it resolve would require additional CI wiring as a follow-up.Validation
bazel build //docs/sphinx:sphinx_doc //:docs_check //:docs # To preview the embedded report locally: xdg-open bazel-bin/docs/sphinx/sphinx_doc/html/index.html