docs: fix broken README model links breaking docs build - #4468
Merged
Merged
Conversation
The Sphinx docs build includes the root README via {include} and treats
relative links as MyST cross-references. The bare source-directory links
for Diffusion/Ernie/Ernie-VL had no resolvable doc target, failing the
--fail-on-warning build. Convert them to full GitHub URLs, matching the
convention already used for other source-code links in the README.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: oliver könig <okoenig@nvidia.com>
Contributor
|
LGTM — the three relative source-directory links are correctly converted to full GitHub URLs, matching the convention already used for every other source-code reference in the README (e.g. line 213). Target directories all exist on Suggested test cases No perf tests impacted. This is a docs-only change. The relevant validation is the Sphinx |
thomasdhc
approved these changes
Jun 23, 2026
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.
Background
The
release / finalize / build-docsjob fails the Sphinx build with--fail-on-warning:docs/index.mdpulls the root README in via{include} ../README.md, so MyST resolves the README's relative links as cross-references. The three Diffusion/Ernie rows in the Supported Models table linked to bare source directories, which have no doc target and fail resolution.What changed
Details
https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/...URLs for every other source-code reference in the README (e.g. model bridges, PEFT, recipes); rows backed by a doc page keep theirdocs/models/<family>/index.mdlink. This change just makes the three offending rows follow the same convention.--fail-on-warningbuild passes.