Skip to content

[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

Merged
merged 2 commits into from
Oct 5, 2023

Conversation

cor3ntin
Copy link
Contributor

@cor3ntin cor3ntin commented Oct 4, 2023

No description provided.

@cor3ntin
Copy link
Contributor Author

cor3ntin commented Oct 4, 2023

This partially fixes #68196

@llvmbot llvmbot added backend:AMDGPU flang Flang issues not falling into any other category labels Oct 4, 2023
@github-actions
Copy link

github-actions bot commented Oct 4, 2023

✅ With the latest revision this PR passed the Python code formatter.

Copy link
Collaborator

@AaronBallman AaronBallman left a 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]

@cor3ntin cor3ntin merged commit 6989c48 into llvm:main Oct 5, 2023
@xgupta
Copy link
Contributor

xgupta commented Oct 6, 2023

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.

@cor3ntin
Copy link
Contributor Author

cor3ntin commented Oct 6, 2023

The one in PointerAuth.md are actual errors: the referenced section simply does not exist.

The two other errors are just invalid cross-document references syntaxes, I haven't looked how to fix them yet.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend:AMDGPU documentation flang Flang issues not falling into any other category
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants