Skip to content

Fix: Clean up malformed cross-references and other sphinx warnings#40

Merged
mbenavidez-amd merged 2 commits into
ROCm:mainfrom
mbenavidez-amd:fix/resolve-warnings
Jun 2, 2026
Merged

Fix: Clean up malformed cross-references and other sphinx warnings#40
mbenavidez-amd merged 2 commits into
ROCm:mainfrom
mbenavidez-amd:fix/resolve-warnings

Conversation

@mbenavidez-amd

@mbenavidez-amd mbenavidez-amd commented Jun 2, 2026

Copy link
Copy Markdown
Collaborator

Motivation

Clean up and resolve recurring sphinx build warnings driven by malformed or incomplete cross-references.

Technical Details

This pull request makes several documentation improvements and fixes to the customer acceptance guide. The main changes include updating and correcting internal and external links, improving formatting for consistency, and enhancing readability by removing unnecessary formatting artifacts.

Documentation Link and Formatting Improvements:

  • Updated several internal documentation links in system-validation.md to use correct or more robust references.
  • Fixed the external link to the "TransferBench how to guide" in related-documentation.md to point to the correct URL.

Formatting and Readability Enhancements:

  • Clarified example JSON output by replacing ellipsis with a comment and removing non-breaking spaces in result explanations.

Documentation Build Configuration:

  • Enabled up to level 4 heading anchors in the Sphinx configuration to improve navigation within generated documentation.

Test Plan

Ran on local builds to ensure changes removed sphinx build warnings.

Test Result

Verified warnings were reesolved in local sphinx builds.

Submission Checklist

@mbenavidez-amd mbenavidez-amd self-assigned this Jun 2, 2026
@mbenavidez-amd mbenavidez-amd added the documentation Improvements or additions to documentation label Jun 2, 2026
@mbenavidez-amd mbenavidez-amd force-pushed the fix/resolve-warnings branch from 96058c4 to 1a983fa Compare June 2, 2026 21:48
@mbenavidez-amd mbenavidez-amd merged commit f0728c2 into ROCm:main Jun 2, 2026
3 checks passed

@rzimmer512 rzimmer512 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Reviewed. No concerns.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants