docs: Fix inconsistent link paths in backends overview table#19244
docs: Fix inconsistent link paths in backends overview table#19244AswaniSahoo wants to merge 2 commits intopytorch:mainfrom
Conversation
Fix backend table links to use relative paths consistently. Several entries used absolute paths (starting with /) while others used relative paths. Absolute paths can break when the documentation is served from a non-root URL. This change standardizes all links to use relative paths, consistent with the toctree directives in the same file. Also removes a trailing space in the Vulkan link text.
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/19244
Note: Links to docs will display an error until the docs builds have been completed.
|
|
Hi @AswaniSahoo! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks! |
There was a problem hiding this comment.
Pull request overview
Standardizes backend documentation links in the backends overview table to use relative paths, preventing broken links when the docs are hosted under a non-root base URL.
Changes:
- Replaced leading-slash (
/backends/...) links with relative (backends/...) links in the backends overview table. - Removed a trailing space in the “Vulkan” link text.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@pytorchbot label "release notes: none" |
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
Summary
Fix backend table links in
docs/source/backends-overview.mdto use relative paths consistently.Several entries in the backends overview table used absolute paths starting with
/(e.g.,/backends/cuda/cuda-overview.md) while others used relative paths (e.g.,backends/xnnpack/xnnpack-overview.md). Absolute paths can break when the documentation is served from a non-root URL.This change standardizes all links to use relative paths, consistent with the
toctreedirectives in the same file. Also removes a trailing space in the Vulkan link text.cc @GregoryComer
Test plan
Verified all target files exist at their relative paths under
docs/source/:backends/cuda/cuda-overview.mdbackends/coreml/coreml-overview.mdbackends/mps/mps-overview.mdbackends/vulkan/vulkan-overview.mdbackends/arm-ethos-u/arm-ethos-u-overview.mdbackends/arm-cortex-m/arm-cortex-m-overview.mdbackends/arm-vgf/arm-vgf-overview.mdbackends/samsung/samsung-overview.md