Fix more doc build warnings: orphan page and MyST cross-references#4494
Open
Ashutosh0x wants to merge 1 commit into
Open
Fix more doc build warnings: orphan page and MyST cross-references#4494Ashutosh0x wants to merge 1 commit into
Ashutosh0x wants to merge 1 commit into
Conversation
Resolves additional warnings from pytorch#3863: - performant_kernels.rst: Mark as :orphan: since it is a placeholder page (contains only 'TBA') that is not included in any toctree. Suppresses the 'document isn't included in any toctree' warning. - benchmarking_api_guide.md: Add explicit MyST target labels before section headers so the table-of-contents cross-reference links resolve correctly. Fixes 4 'myst cross-reference target not found' warnings. Partial fix for pytorch#3863 Test Plan: Documentation-only change. Verified the MyST target syntax and :orphan: directive match Sphinx/MyST specifications by inspection. This change was authored with the assistance of an AI coding assistant.
meta-cla
Bot
added
the
CLA Signed
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/ao/4494
Note: Links to docs will display an error until the docs builds have been completed. This comment was automatically generated by Dr. CI and updates every 15 minutes. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Resolves 5 more Sphinx doc build warnings tracked in #3863, complementing PR #4490.
Fixes
docs/source/performant_kernels.rst(1 warning):Mark as
:orphan:since it is a placeholder page (contains only 'TBA') not included in any toctree. Suppresses:\
WARNING: document isn't included in any toctree
\\
docs/source/contributing/benchmarking_api_guide.md(4 warnings):Add explicit MyST target labels
(add-an-api-to-benchmarking-recipes)=etc. before section headers so the table-of-contents cross-reference links resolve. Fixes:\
WARNING: 'myst' cross-reference target not found: 'add-an-api-to-benchmarking-recipes'
WARNING: 'myst' cross-reference target not found: 'add-a-model-to-benchmarking-recipes'
WARNING: 'myst' cross-reference target not found: 'add-an-hf-model-to-benchmarking-recipes'
WARNING: 'myst' cross-reference target not found: 'add-an-api-to-benchmarking-ci-dashboard'
\\
Combined with PR #4490, this resolves 9 of the 114 warnings from #3863.
Partial fix for #3863
Test Plan
Documentation-only change. Verified the MyST target syntax and
:orphan:directive match Sphinx/MyST specifications by inspection.This change was authored with the assistance of an AI coding assistant.