Fix broken {include} paths rendering 3 empty doc pages#19585
Conversation
Three platform-specific redirect pages had {include} directives pointing to files that don't exist (backends-coreml.md, backends-mps.md, backends-arm-ethos-u.md). These files were moved to subdirectories during the backend docs reorganization but the include paths were not updated.
Fixed by updating include paths to match the correct subdirectory locations, consistent with the working equivalents (ios-coreml.md, ios-mps.md, embedded-arm-cortex-m.md).
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/19585
Note: Links to docs will display an error until the docs builds have been completed. ❗ 1 Active SEVsThere are 1 currently active SEVs. If your PR is affected, please view them below: ⏳ 6 Pending, 1 Unrelated FailureAs of commit 395d17c with merge base a92200f ( BROKEN TRUNK - The following job failed but were present on the merge base:👉 Rebase onto the `viable/strict` branch to avoid these failures
This comment was automatically generated by Dr. CI and updates every 15 minutes. |
There was a problem hiding this comment.
Pull request overview
This PR fixes three documentation “redirect” pages that render empty on the live site due to broken MyST {include} paths after the backend docs were reorganized into subdirectories. It updates the includes to point at the current backend overview markdown files under docs/source/backends/..., matching the already-working iOS/embedded equivalents.
Changes:
- Update
desktop-coreml.mdto includebackends/coreml/coreml-overview.md. - Update
desktop-mps.mdto includebackends/mps/mps-overview.md. - Update
embedded-arm-ethos-u.mdto includebackends/arm-ethos-u/arm-ethos-u-overview.md.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/source/desktop-coreml.md | Fix {include} target to CoreML backend overview in the new backends/coreml/ location. |
| docs/source/desktop-mps.md | Fix {include} target to MPS backend overview in the new backends/mps/ location. |
| docs/source/embedded-arm-ethos-u.md | Fix {include} target to Arm Ethos-U backend overview in the new backends/arm-ethos-u/ location. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@pytorchbot label "release notes: none" |
Summary
Fix broken
{include}directives in three documentation pages that currentlyrender as completely empty pages (
<no title>) on the live docs site.When backend docs were reorganized from flat files (e.g.
backends-coreml.md)into subdirectories (e.g.
backends/coreml/coreml-overview.md), these threeplatform-specific redirect pages were not updated to match the new paths:
desktop-coreml.md— included non-existentbackends-coreml.mddesktop-mps.md— included non-existentbackends-mps.mdembedded-arm-ethos-u.md— included non-existentbackends-arm-ethos-u.mdUpdated include paths to match the correct subdirectory locations, consistent
with the working equivalents (
ios-coreml.md,ios-mps.md,embedded-arm-cortex-m.md).Fixes #19445
cc @digantdesai @freddan80 @per @zingo @oscarandersson8218 @mansnils @Sebastian-Larsson @robell @rascani @GregoryComer @AlannaBurke @mergennachin
Test plan
(
backends/coreml/coreml-overview.md,backends/mps/mps-overview.md,backends/arm-ethos-u/arm-ethos-u-overview.md)ios-coreml.md,ios-mps.md,embedded-arm-cortex-m.md) use the same corrected pathsand render correctly on the live site