Skip to content

Add missing version selector for 2.1.1#6396

Merged
JanuszL merged 1 commit into
NVIDIA:mainfrom
JanuszL:missing_selector_2.1.1
Jun 16, 2026
Merged

Add missing version selector for 2.1.1#6396
JanuszL merged 1 commit into
NVIDIA:mainfrom
JanuszL:missing_selector_2.1.1

Conversation

@JanuszL

@JanuszL JanuszL commented Jun 15, 2026

Copy link
Copy Markdown
Contributor
  • adds missing version selector for DALI patch release 2.1.1

Category:

Other (e.g. Documentation, Tests, Configuration)

Description:

  • adds missing version selector for DALI patch release 2.1.1

Additional information:

Affected modules and functionalities:

  • docs

Key points relevant for the review:

  • NA

Tests:

  • Existing tests apply
  • New tests added
    • Python tests
    • GTests
    • Benchmark
    • Other
  • N/A

Checklist

Documentation

  • Existing documentation applies
  • Documentation updated
    • Docstring
    • Doxygen
    • RST
    • Jupyter
    • Other
  • N/A

DALI team only

Requirements

  • Implements new requirements
  • Affects existing requirements
  • N/A

REQ IDs: N/A

JIRA TASK: N/A

@JanuszL JanuszL force-pushed the missing_selector_2.1.1 branch 2 times, most recently from 7c48c04 to 13f10a0 Compare June 15, 2026 21:14
@JanuszL

JanuszL commented Jun 15, 2026

Copy link
Copy Markdown
Contributor Author

!build

@greptile-apps

greptile-apps Bot commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR adds the DALI 2.1.1 patch release to the documentation version switcher by appending an entry to the versions list in docs/conf.py.

  • The new entry uses "dali_2.1.1" (dots) as the archive path identifier rather than the underscore convention "dali_2_1_1" used by every other patch release ("dali_1_37_1", "dali_1_11_1") and generated minor releases (f"dali_{v_major}_{i}_0"), producing a broken archive URL.
  • After version-sorting, the 2.1.1 entry lands at index 2 of json_data, which is the exact position the build-time URL validation loop explicitly skips, so the incorrect URL will not be caught automatically.

Confidence Score: 4/5

The single changed line produces an archive URL with dots in the path segment instead of underscores, matching no known NVIDIA docs archive location. The build-time URL check that would normally catch this is unconditionally skipped for the index where 2.1.1 lands after sorting.

The archive identifier 'dali_2.1.1' diverges from the established underscore convention and will generate a URL that likely does not resolve. Because the URL validator skips exactly this index at build time, the error would reach production undetected. Fixing the identifier to 'dali_2_1_1' is a one-character change.

docs/conf.py — the archive path identifier on the newly added line.

Important Files Changed

Filename Overview
docs/conf.py Adds 2.1.1 patch version to the version-switcher list, but uses "dali_2.1.1" (dots) as the archive path identifier instead of the correct "dali_2_1_1" (underscores), producing a broken URL. URL validation is also bypassed for this entry at build time.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[versions list built] --> B[append 2.1.1 entry
'dali_2.1.1' dots used]
    B --> C[versions sorted descending
by Version number]
    C --> D[json_data built with URLs
using archive identifier]
    D --> E[json_data trimmed to 10]
    E --> F{URL validation loop}
    F -->|index == 2 SKIP| G[2.1.1 entry at index 2
URL never validated]
    F -->|other indices| H[HEAD request to URL]
    H -->|status >= 400| I[exit 1]
    H -->|status < 400| J[OK]
    G --> K[switcher.json written with
broken dali_2.1.1 URL]
    J --> K
Loading

Reviews (2): Last reviewed commit: "Add missing version selector for 2.1.1" | Re-trigger Greptile

Comment thread docs/conf.py Outdated
for i in range(0, v_minor + correction):
versions.append((f"{v_major}.{i}", f"dali_{v_major}_{i}_0", "short_user"))

versions.append(("2.1.1", "2.1.1", "short_user"))

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.

P1 [Question] Archive path uses bare version string, not dali_ convention

Every other patch release uses the dali_x_y_z identifier as the archive path segment — e.g. ("1.37.1", "dali_1_37_1", "short_user") and ("1.11.1", "dali_1_11_1"). Regular minor releases use the same pattern via the loop: f"dali_{v_major}_{i}_0". Here, the second tuple element is "2.1.1" (the bare version string), which causes the short_user branch to generate the URL https://docs.nvidia.com/deeplearning/dali/archives/2.1.1/user-guide/ instead of the pattern-consistent https://docs.nvidia.com/deeplearning/dali/archives/dali_2_1_1/user-guide/. URL validation in conf.py explicitly skips index 2 (which this entry occupies after sorting), so a broken link would not be caught at build time. Can you confirm the exact archive path used for the 2.1.1 docs?

Fix in Claude Code

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Fixed

@dali-automaton

Copy link
Copy Markdown
Collaborator

CI MESSAGE: [54861749]: BUILD STARTED

- adds missing version selector for DALI patch release
  2.1.1

Signed-off-by: Janusz Lisiecki <jlisiecki@nvidia.com>
@JanuszL JanuszL force-pushed the missing_selector_2.1.1 branch from 13f10a0 to 489fd50 Compare June 15, 2026 21:22
@JanuszL

JanuszL commented Jun 15, 2026

Copy link
Copy Markdown
Contributor Author

!build

@dali-automaton

Copy link
Copy Markdown
Collaborator

CI MESSAGE: [54862240]: BUILD STARTED

@dali-automaton

Copy link
Copy Markdown
Collaborator

CI MESSAGE: [54862240]: BUILD PASSED

@JanuszL JanuszL merged commit eb05711 into NVIDIA:main Jun 16, 2026
7 checks passed
@JanuszL JanuszL deleted the missing_selector_2.1.1 branch June 16, 2026 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants