Skip to content

Replace relative source links with github links #577

@terrykong

Description

@terrykong

Currently relative hyperlinks to source in github have some unexpected properties when rendered with myst-parser.

Example:

The yaml in this page: https://docs.nvidia.com/nemo/rl/latest/guides/grpo.html#quickstart-launch-a-grpo-run actually causes the yaml to be downloaded.

It is probably a better user experience to replace those links with hyperlinks to https://github/..../NVIDIA-NeMo/RL/blob/$LATEST_OR_VERSION_REF_IN_VERSIONS_TXT/$RELATIVE_PATH

Another issue is that relative paths to directories cause errors when sphinx docs are building https://github.com/NVIDIA-NeMo/RL/actions/runs/15918429368/job/44900311846?pr=553

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingdocumentationImprovements or additions to documentation

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions