Fix left nav TOC for backends overview page in main#16861
Conversation
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/16861
Note: Links to docs will display an error until the docs builds have been completed. ✅ No FailuresAs of commit c20582b with merge base 15ad846 ( This comment was automatically generated by Dr. CI and updates every 15 minutes. |
meta-cla
Bot
added
the
CLA Signed
This PR needs a
|
There was a problem hiding this comment.
Pull request overview
Fixes broken Sphinx/MyST toctree entries so the Backends Overview left-nav includes all expected backend pages again (regression from #15219).
Changes:
- Update
docs/source/backends-overview.mdto pointtoctreeentries at the correct per-backend overview doc paths. - Remove an unnecessary hidden
toctreefromnxp-dim-order.md(the NXP section navigation is already driven fromnxp-overview.md).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/source/backends-overview.md | Corrects toctree doc paths so all backend pages resolve and appear in the left-nav. |
| docs/source/backends/nxp/nxp-dim-order.md | Removes a redundant toctree block that isn’t needed for NXP section navigation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
mergennachin
force-pushed
the
fix_links_123
branch
from
955dfe3 to
c20582b
Compare
|
@pytorchbot cherry-pick --onto release/1.1 -c docs |
The backends-overview page was only showing 6 backends instead of 13. This regression was introduced in commit cdc2701 (NXP Backend: Update documentation to the new scheme #15219) which inadvertently reverted correct toctree paths to incorrect ones during a table reformatting. - Toctree entries used old flat paths (e.g., backends-xnnpack) instead of the new subdirectory paths (e.g., backends/xnnpack/xnnpack-overview) - A circular toctree dependency between nxp-overview.md and nxp-dim-order.md caused Sphinx build failures Test Plan: Built sphinx locally and rendered page https://docs-preview.pytorch.org/pytorch/executorch/16861/backends-section.html (cherry picked from commit 29b31da)
Cherry picking #16861The cherry pick PR is at #16869 The following tracker issues are updated: Details for Dev Infra teamRaised by workflow job |
The backends-overview page was only showing 6 backends instead of 13. This regression was introduced in commit cdc2701 (NXP Backend: Update documentation to the new scheme #15219) which inadvertently reverted correct toctree paths to incorrect ones during a table reformatting.
Test Plan: Built sphinx locally and rendered page
https://docs-preview.pytorch.org/pytorch/executorch/16861/backends-section.html