cp: docs: Hardcode docs github url (1328) into r0.4.0

[chtruong814]

beep boop [🤖]: Hi @chtruong814 👋,

we've cherry picked #1328 into  for you! 🚀

Please review and approve this cherry pick by your convenience!

Summary by CodeRabbit

• Documentation
  • Standardized documentation source links to consistently point to the correct GitHub repository.
  • Improves reliability of “View source”/“Edit on GitHub” links across the docs.
  • Reduces risk of broken or mismatched links; graceful fallback remains unchanged if link generation fails.
  • No impact on application behavior; change only affects documentation link generation.

[coderabbitai]

📝 Walkthrough

Walkthrough

Replaced dynamic repository URL resolution in docs/conf.py’s _GitHubLinkTransform.apply with a hardcoded GitHub URL ("https://github.com/NVIDIA-NeMo/RL"), keeping existing try/except and link construction logic intact.

Changes

Cohort / File(s)	Summary
Docs config docs/conf.py	In _GitHubLinkTransform.apply, replaced _get_github_source_url(local_repo) with fixed remote_repo_url = "https://github.com/NVIDIA-NeMo/RL". Preserved try/except and subsequent refuri construction; only the source base URL determination changed.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• docs: Hardcode docs github url #1328 — Also changes _GitHubLinkTransform.apply in docs/conf.py to use the same hardcoded GitHub URL, indicating a direct overlap.

Suggested labels

CI:docs

Suggested reviewers

• terrykong

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title clearly describes the main change of hardcoding the GitHub URL in the documentation configuration, reflecting the core modification implemented in docs/conf.py. The reference to a cherry-pick and branch is contextual but does not obscure the substantive update. The essential intent of the change is immediately clear to reviewers.
Test Results For Major Changes	✅ Passed	The pull request only hardcodes a GitHub documentation URL in docs/conf.py, with no feature work, numerics-sensitive logic, or performance-impacting changes, so it qualifies as a minor update. For minor changes the check passes even without explicit test results. Therefore the PR satisfies the custom check requirements.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch cherry-pick-1328-r0.4.0

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/conf.py (1)

173-189: Remove or document the unused _get_github_source_url method.

This method is no longer called anywhere in the codebase after the hardcoded URL change. If the hardcoding at line 196 is temporary and this method will be used again, add a comment explaining that. Otherwise, remove the method to avoid maintaining dead code.

To verify this method is unused elsewhere:

#!/bin/bash
# Description: Verify _get_github_source_url is not called from other files

# Search for calls to _get_github_source_url
rg -n --type=py '_get_github_source_url' -g '!docs/conf.py'

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1faf2f1 and 9922dc9.

📒 Files selected for processing (1)

• docs/conf.py (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.py

📄 CodeRabbit inference engine (CODING_GUIDELINES.md)

**/*.py: Follow the Google Python Style Guide for all Python code
Target Python 3.12+ for all Python code in NeMo-RL
Indent Python code with 4 spaces; do not use tabs
Python filenames should be snake_case (e.g., some_file.py)
Class names should be PascalCase
Function and method names should be snake_case
Local variable names should be snake_case; if starting with a number, prefix with k (e.g., k_99th_percentile)
Global variables should be UPPER_SNAKE_CASE and prefixed with G_ (e.g., G_MY_GLOBAL)
Constants should be UPPER_SNAKE_CASE
Avoid shadowing variables declared in an outer scope
Initialize all externally visible members of a class in the constructor
For public interfaces used outside a file, prefer docstrings over comments
Use comments mainly for code within a function or interfaces local to a file
Commented-out code must include a nearby comment explaining usage and why it is commented out; otherwise remove before merging
Use Google-style docstrings for classes and functions (Sphinx-parseable)
Avoid using reflection when functionality can be easily achieved without it
Limit except clauses to the smallest specific set of exceptions possible
For duck-typing via try/except, keep the try body minimal and use else for main logic
Add the NVIDIA copyright header (with current year) at the top of all Python files, excluding tests/ and test-only scripts

Files:

• docs/conf.py

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)

• GitHub Check: Lint check
• GitHub Check: Lint check
• GitHub Check: Lint check
• GitHub Check: Post submodule check comment / Comment on PR
• GitHub Check: Post automodel integration comment / Comment on PR

🔇 Additional comments (1)

docs/conf.py (1)

194-196: Clarify the temporary nature and tracking for this workaround.

The hardcoded URL is correct and the logic works as expected. However, the comment indicates this is a temporary workaround ("for now"), but doesn't provide clear tracking or criteria for when it might be reverted.

Per the coding guidelines, commented-out code should include more complete documentation. Consider either:

1. Creating a tracking issue/TODO and referencing it in the comment
2. Removing the commented-out line if this change is intended to be permanent
3. Adding more detail about the specific build environment errors and when reverting would be safe

As per coding guidelines.