Skip to content

Fix broken {include} paths rendering 3 empty doc pages#19585

Merged
GregoryComer merged 3 commits into
pytorch:mainfrom
AswaniSahoo:docathon/fix-broken-include-paths
May 14, 2026
Merged

Fix broken {include} paths rendering 3 empty doc pages#19585
GregoryComer merged 3 commits into
pytorch:mainfrom
AswaniSahoo:docathon/fix-broken-include-paths

Conversation

@AswaniSahoo
Copy link
Copy Markdown
Contributor

@AswaniSahoo AswaniSahoo commented May 14, 2026

Summary

Fix broken {include} directives in three documentation pages that currently
render 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 three
platform-specific redirect pages were not updated to match the new paths:

  • desktop-coreml.md — included non-existent backends-coreml.md
  • desktop-mps.md — included non-existent backends-mps.md
  • embedded-arm-ethos-u.md — included non-existent backends-arm-ethos-u.md

Updated 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

  • Verified the three target files exist at the corrected paths
    (backends/coreml/coreml-overview.md, backends/mps/mps-overview.md,
    backends/arm-ethos-u/arm-ethos-u-overview.md)
  • Confirmed the equivalent iOS/embedded pages (ios-coreml.md,
    ios-mps.md, embedded-arm-cortex-m.md) use the same corrected paths
    and render correctly on the live site
  • No changes to source code; documentation-only PR

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).
Copilot AI review requested due to automatic review settings May 14, 2026 13:13
@AswaniSahoo AswaniSahoo requested a review from mergennachin as a code owner May 14, 2026 13:13
@pytorch-bot
Copy link
Copy Markdown

pytorch-bot Bot commented May 14, 2026

🔗 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 SEVs

There are 1 currently active SEVs. If your PR is affected, please view them below:

⏳ 6 Pending, 1 Unrelated Failure

As of commit 395d17c with merge base a92200f (image):

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.

@meta-cla meta-cla Bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label May 14, 2026
@github-actions github-actions Bot added the module: arm Issues related to arm backend label May 14, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.md to include backends/coreml/coreml-overview.md.
  • Update desktop-mps.md to include backends/mps/mps-overview.md.
  • Update embedded-arm-ethos-u.md to include backends/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.

@AswaniSahoo
Copy link
Copy Markdown
Contributor Author

@pytorchbot label "release notes: none"

@pytorch-bot pytorch-bot Bot added the release notes: none Do not include this in the release notes label May 14, 2026
@GregoryComer GregoryComer merged commit 4c474af into pytorch:main May 14, 2026
173 of 174 checks passed
@AswaniSahoo AswaniSahoo deleted the docathon/fix-broken-include-paths branch May 15, 2026 05:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. module: arm Issues related to arm backend release notes: none Do not include this in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Fix broken {include} paths rendering 3 empty pages (desktop-coreml, desktop-mps, embedded-arm-ethos-u)

5 participants