-
Notifications
You must be signed in to change notification settings - Fork 13.5k
[Documentation] Fix some invalid references in sphinx documentation #68239
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
This partially fixes #68196 |
✅ With the latest revision this PR passed the Python code formatter. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! The only remaining issues I see when building LLVM docs locally are:
F:\source\llvm-project\llvm\docs\GitRepositoryPolicy.md:21: WARNING: 'myst' cross-reference target not found: 'DeveloperPolicy.html#adding-an-established-project-to-the-llvm-monorepo>' [myst.xref_missing]
F:\source\llvm-project\llvm\docs\InstrRefDebugInfo.md:96: WARNING: 'myst' cross-reference target not found: 'SourceLevelDebugging.html#livedebugvalues-expansion-of-variable-locations' [myst.xref_missing]
F:\source\llvm-project\llvm\docs\MarkdownQuickstartTemplate.md:161: WARNING: 'myst' cross-reference target not found: 'SphinxQuickstartTemplate.html#generating-the-documentation' [myst.xref_missing]
F:\source\llvm-project\llvm\docs\PointerAuth.md:306: WARNING: 'myst' cross-reference target not found: 'authenticated-global-relocation' [myst.xref_missing]
F:\source\llvm-project\llvm\docs\PointerAuth.md:331: WARNING: 'myst' cross-reference target not found: 'authenticated-global-relocation' [myst.xref_missing]
I saw them too, seems warnings are treated as errors by default. |
The one in The two other errors are just invalid cross-document references syntaxes, I haven't looked how to fix them yet. |
No description provided.