fix(hipsparse): Fix doxygen errors caused by README#9356
Merged
Conversation
✅ All Checks Passed — Ready for Review
📖 Need help? See the Policy FAQ for details on every check and how to fix failures. |
|
🎉 All checks passed! This PR is ready for review. |
kliegeois
approved these changes
Jul 13, 2026
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
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.
Motivation
Fix Doxygen build failure from unresolved in-page README links
Summary
The documentation build (
rocm_docs.doxygen) was aborting with errors like:Doxygen converts Markdown in-page links (
[text](#anchor)) into\ref anchorcommands. Unlike GitHub-flavored Markdown, Doxygen does not auto-generate slug anchors from heading text, so these links pointed to non-existent references. Because the docs build treats warnings as errors, this caused Doxygen (and the Sphinx extension wrapping it) to fail.Changes
Added explicit Doxygen anchors to the headings targeted by in-page links in
README.md:## Options→## Options {#options}### Using CMake variables directly→### Using CMake variables directly {#using-cmake-variables-directly}These were the only two
](#...)anchor links in the file.These errors were not reproducible with doxygen 1.9.1 by are in doxygen 1.9.8
JIRA ID: AISPARSE-590