Skip to content

fix(docs): sort version dropdown branches numerically - #1256

Merged
jiwenc-nv merged 1 commit into
NVIDIA:mainfrom
jiwenc-nv:jiwenc/doc-version-1.6-missing
Oct 13, 2026
Merged

jiwenc-nv merged 1 commit into
NVIDIA:mainfrom
jiwenc-nv:jiwenc/doc-version-1.6-missing

Conversation

@jiwenc-nv

@jiwenc-nv jiwenc-nv commented Oct 13, 2026 •

Copy link
Copy Markdown
Collaborator

The docs dropdown inherits Git ref order, so the branch that triggers deployment can appear above main (for example, release/1.6.x).

Sort branches with main first, then releases in ascending numeric order, including 1.9 before 1.10. Tag ordering is unchanged. Two files, no new dependencies.

Validation: make -C docs current-docs; all pre-commit hooks with SKIP=check-copyright-year; template rendering across 120 branch permutations, checking numeric order and selected-version links.

Summary by CodeRabbit

  • Documentation
    • Branch options in the version selector are now ordered with main first, followed by branches in numeric and alphabetical order. Tag options remain unchanged. This makes branch versions easier to scan and compare when choosing documentation.

Signed-off-by: Jiwen Cai <jiwenc@nvidia.com>
@coderabbitai

coderabbitai Bot commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: NVIDIA/IsaacCapture/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Enterprise
  • Run ID: fe937434-4aa4-43ca-ad9a-e6fa22419b6d
📥 Commits

Reviewing files that changed from the base of the PR and between 2fe1bbe and 1f03bb1.

📒 Files selected for processing (2)
  • docs/source/_templates/versioning.html
  • docs/source/conf.py

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 11 remain after this review.

📝 Walkthrough

The version selector now sorts branch options with sort_doc_branches. The sorter places main first, then sorts branch names by numeric components and lexical order. Sphinx adds the sorter to each page’s template context through the html-page-context event. Tag options remain unchanged.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~8 minutes

Merge Risk: ⚪ Minimal · up to 1f03b

The change is limited to ordering documentation branch options; no identified issue warrants delaying merge.

Pre-merge checks · Passed 4 · Failed 1

Failed 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%. Docstring coverage is scoped to functions touched by this diff. Analyzed 3 functions across 1 files. (1 skipped: 1 … Write docstrings for the functions missing them to satisfy the coverage threshold.
Passed Passed checks (4 passed)
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main change: numeric sorting of branches in the documentation version dropdown.
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 3 functions across 1 files. (1 skipped: 1 unsupported.)

  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown
Contributor

📝 Docs preview is not auto-deployed for fork PRs.

A maintainer with write access to NVIDIA/IsaacCapture can deploy a preview by
commenting /preview-docs on this PR. Once deployed, the preview
will live at:

https://nvidia.github.io/IsaacCapture/preview/pr-1256/

@jiwenc-nv
jiwenc-nv marked this pull request as ready for review October 13, 2026 18:02

@ivany-nv ivany-nv left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Legend: 🚫 BLOCKER = merge-blocking | 💡 SUGGESTION = meaningful improvement | 🧹 NIT = precise small correction

Finding
🚫 none
💡 none
🧹 none

@jiwenc-nv
jiwenc-nv merged commit 63a6935 into NVIDIA:main Oct 13, 2026
34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants