Skip to content

fix(hipsparse): Fix doxygen errors caused by README#9356

Merged
kliegeois merged 1 commit into
ROCm:developfrom
jsandham:fix_readme
Jul 13, 2026
Merged

fix(hipsparse): Fix doxygen errors caused by README#9356
kliegeois merged 1 commit into
ROCm:developfrom
jsandham:fix_readme

Conversation

@jsandham

@jsandham jsandham commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Motivation

Fix Doxygen build failure from unresolved in-page README links

Summary

The documentation build (rocm_docs.doxygen) was aborting with errors like:

README.md:45: error: unable to resolve reference to 'options' for \ref command (warning treated as error, aborting now)
README.md:55: error: unable to resolve reference to 'using-cmake-variables-directly' for \ref command (warning treated as error, aborting now)

Doxygen converts Markdown in-page links ([text](#anchor)) into \ref anchor commands. 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

@therock-pr-bot

therock-pr-bot Bot commented Jul 13, 2026

Copy link
Copy Markdown

✅ All Checks Passed — Ready for Review

Check Status Details
🌿 Branch Name ✅ Pass
📝 PR Title/Description ✅ Pass
Forbidden Files ✅ Pass
🧪 Unit Test ✅ Pass PR does not contain code files — Unit Test auto-passed
🔎 pre-commit ✅ Pass
🚫 Draft PR 🔜 To Be Enabled
🚩 Feature Flag 🔜 To Be Enabled
📊 Code Coverage 🔜 To Be Enabled
🤖 therock-pr-bot ✅ Pass

🎉 All checks passed! This PR is ready for review.

📖 Need help? See the Policy FAQ for details on every check and how to fix failures.

@therock-pr-bot

therock-pr-bot Bot commented Jul 13, 2026

Copy link
Copy Markdown

🎉 All checks passed! This PR is ready for review.

@kliegeois kliegeois merged commit 8e2dca1 into ROCm:develop Jul 13, 2026
32 of 36 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants