feat: docs_bundle - #671
Open
AlexanderLanin wants to merge 10 commits into
Open
Conversation
License Check Results🚀 The license check job ran with the Bazel command: bazel run --lockfile_mode=error //src:license-checkStatus: Click to expand output |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| env["SCORE_SOURCELINKS"] = str(sourcelinks) | ||
|
|
||
| return subprocess.run( | ||
| [str(docs_binary)], |
Contributor
There was a problem hiding this comment.
This is a build system. No need to be defensive here.
| env["SCORE_SOURCELINKS"] = str(sourcelinks) | ||
|
|
||
| return subprocess.run( | ||
| [str(docs_binary)], |
a-zw
reviewed
Jul 28, 2026
|
|
||
| docs_sources_env["ACTION"] = "incremental" | ||
| py_binary( | ||
| name = "docs_combo", |
Contributor
There was a problem hiding this comment.
Moving too fast. Keep docs_combo for backwards-compatibility.
a-zw
reviewed
Jul 28, 2026
Co-authored-by: Maximilian Sören Pollak <maximilian.pollak@qorix.com>
| exec root in a sandbox) is the caller's responsibility. | ||
| """ | ||
| manifest_path = Path(manifest_path) | ||
| data = json.loads(manifest_path.read_text(encoding="utf-8")) |
a-zw
reviewed
Jul 29, 2026
| | ---------------------------------------------- | ------------------------------------------------------------------------------------------------- | | ||
| | `bazel run //:docs` | Builds documentation (also writes `metrics.json`) | | ||
| | `bazel run //:docs_check` | Verifies documentation correctness | | ||
| | `bazel run //:docs_combo` | Builds combined documentation with all external dependencies included | |
Contributor
There was a problem hiding this comment.
Please avoid the breaking change of removing :docs_combo
Member
Author
There was a problem hiding this comment.
docs_combo only works in ref int, and we will add it there as an alias. We need to change BUILD file anyway.
AlexanderLanin
marked this pull request as ready for review
July 29, 2026 10:12
AlexanderLanin
requested review from
MaximilianSoerenPollak,
dcalavrezo-qorix and
nradakovic
as code owners
July 29, 2026 10:12
a-zw
reviewed
Jul 29, 2026
|
|
||
| The pieces fit together like this: | ||
|
|
||
| .. code-block:: text |
Contributor
There was a problem hiding this comment.
Use mermaid or at least plantuml for such diagrams.
a-zw
reviewed
Jul 29, 2026
| real, editable sources. | ||
|
|
||
|
|
||
| How the wiring works |
Contributor
There was a problem hiding this comment.
This section is explanation and not a how-to.
AlexanderLanin
commented
Jul 29, 2026
| """Write full config, so the final configuration is visible in one file.""" | ||
|
|
||
| config_setdefault(app.config, "needscfg_exclude_defaults", True) | ||
| config_setdefault(app.config, "needscfg_exclude_defaults", False) |
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
3 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.
Bundles!
📌 Description
🚨 Impact Analysis
✅ Checklist