docs: Replace symlinks at build time to use markdown link syntax - #113
Merged
Conversation
Signed-off-by: Charlie Truong <chtruong@nvidia.com>
|
|
||
| - {doc}`nemo-megatron-bridge <nemo-megatron-bridge/README>` — Recipe using [NeMo Megatron-Bridge](https://github.com/NVIDIA-NeMo/Megatron-Bridge) | ||
| - {doc}`nemo-automodel <nemo-automodel/README>` — Recipe using [NeMo AutoModel](https://github.com/NVIDIA-NeMo/Automodel) | ||
| - [nemo-megatron-bridge](nemo-megatron-bridge/README.md) — Recipe using [NeMo Megatron-Bridge](https://github.com/NVIDIA-NeMo/Megatron-Bridge) |
Contributor
There was a problem hiding this comment.
Thanks, is it all possible that it it points to the folder, and not the README.md files ?
shashank3959
approved these changes
Mar 13, 2026
anniesurla
added a commit
to anniesurla/Nemotron
that referenced
this pull request
Mar 16, 2026
…DIA-NeMo#113) Signed-off-by: Charlie Truong <chtruong@nvidia.com> Signed-off-by: Annie Surla <110621965+anniesurla@users.noreply.github.com>
shashank3959
added a commit
that referenced
this pull request
Mar 17, 2026
… (#118) Signed-off-by: Charlie Truong <chtruong@nvidia.com> Signed-off-by: Annie Surla <110621965+anniesurla@users.noreply.github.com> Co-authored-by: Shashank Verma <shashankv@nvidia.com>
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.
docs: Replace symlinks at build time to use markdown link syntax
For the files that are symlinked into the docs, directory, we had to use sphinx link format to make the references work. However, this can lead to an awkward experience for users that read the docs from the Github repo. To avoid this, we copy the directories and remove the symlink at build time during the CI. And in the repo, we can replace the sphinx link with the markdown link for better readability.