Fix docs version selector paths for DALI 2.x#6354
Conversation
The docs version selector generated legacy-version entries without marking them as short user-guide links. For DALI 2.x pages, that made the selector add an unnecessary `docs/` path component. Mark generated DALI 2.x entries with the existing `short_user` path mode so the selector builds links that match the published layout. Signed-off-by: Janusz Lisiecki <jlisiecki@nvidia.com>
|
!build |
|
| Filename | Overview |
|---|---|
| docs/conf.py | Adds "short_user" path mode to DALI 2.x version entries so the switcher generates /user-guide/ URLs instead of /user-guide/docs/, matching the published archive layout for these versions |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A["versions tuple\n(version, archive, mode?)"] --> B{mode present?}
B -- "mode == 'devel'" --> C["/archives/{archive}/dali-developer-guide/docs/"]
B -- "mode == 'short_devel'" --> D["/archives/{archive}/dali-developer-guide/"]
B -- "mode == 'short_user'" --> E["/archives/{archive}/user-guide/"]
B -- "no mode (else)" --> F["/archives/{archive}/user-guide/docs/"]
G["DALI 2.x entries\n(before fix)"] -- "no mode → else branch" --> F
H["DALI 2.x entries\n(after fix)"] -- "short_user" --> E
I["DALI 1.34+ entries\n(existing)"] -- "short_user" --> E
Reviews (1): Last reviewed commit: "Fix docs version selector paths for DALI..." | Re-trigger Greptile
|
CI MESSAGE: [51728812]: BUILD STARTED |
|
CI MESSAGE: [51728812]: BUILD PASSED |
The docs version selector generated legacy-version entries without marking them as short user-guide links. For DALI 2.x pages, that made the selector add an unnecessary `docs/` path component. Mark generated DALI 2.x entries with the existing `short_user` path mode so the selector builds links that match the published layout. Signed-off-by: Janusz Lisiecki <jlisiecki@nvidia.com>
The docs version selector generated legacy-version entries without marking them as short user-guide links. For DALI 2.x pages, that made the selector add an unnecessary `docs/` path component. Mark generated DALI 2.x entries with the existing `short_user` path mode so the selector builds links that match the published layout. Signed-off-by: Janusz Lisiecki <jlisiecki@nvidia.com>
Category:
Other (Documentation)
Description:
It fixes the docs version selector for DALI 2.x generated entries. Those
entries were not marked as short user-guide links, which made the selector add
an unnecessary
docs/path component.The generated DALI 2.x entries now use the existing
short_userpath mode sothe selector builds links that match the published layout.
Additional information:
Affected modules and functionalities:
Docs configuration for the version selector in
docs/conf.py.Key points relevant for the review:
The generated version entries for the current major release now include the
path mode expected by the selector link-generation logic.
Tests:
Checklist
Documentation
DALI team only
Requirements
REQ IDs: N/A
JIRA TASK: N/A