Skip to content

docs(hipsparse): fix documentation warnings - #10578

Merged
jsandham merged 1 commit into
ROCm:developfrom
jsandham:fix_hipsparse_docs
Aug 10, 2026
Merged

jsandham merged 1 commit into
ROCm:developfrom
jsandham:fix_hipsparse_docs

Conversation

@jsandham

Copy link
Copy Markdown
Contributor

Motivation

The documentation warnings:

/src/rocm-libraries/projects/hipsparse/docs/reference/generic.rst:346: WARNING: doxygenfunction: Cannot find function "hipsparseSpGEAM_createDescr" in doxygen xml output for project "hipsparse" from directory: doxygen/xml [docutils]
/src/rocm-libraries/projects/hipsparse/docs/reference/generic.rst:351: WARNING: doxygenfunction: Cannot find function "hipsparseSpGEAM_destroyDescr" in doxygen xml output for project "hipsparse" from directory: doxygen/xml [docutils]
/src/rocm-libraries/projects/hipsparse/docs/reference/generic.rst:356: WARNING: doxygenfunction: Cannot find function "hipsparseSpGEAM_bufferSize" in doxygen xml output for project "hipsparse" from directory: doxygen/xml [docutils]
/src/rocm-libraries/projects/hipsparse/docs/reference/generic.rst:361: WARNING: doxygenfunction: Cannot find function "hipsparseSpGEAM_nnz" in doxygen xml output for project "hipsparse" from directory: doxygen/xml [docutils]
/src/rocm-libraries/projects/hipsparse/docs/reference/generic.rst:366: WARNING: doxygenfunction: Cannot find function "hipsparseSpGEAM" in doxygen xml output for project "hipsparse" from directory: doxygen/xml [docutils]
/src/rocm-libraries/projects/hipsparse/docs/reference/types.rst:118: WARNING: doxygentypedef: Cannot find typedef "hipsparseSpGEAMDescr_t" in doxygen xml output for project "hipsparse" from directory: doxygen/xml [docutils]
/src/rocm-libraries/projects/hipsparse/docs/reference/types.rst:265: WARNING: doxygenenum: Cannot find enum "hipsparseSpGEAMAlg_t" in doxygen xml output for project "hipsparse" from directory: doxygen/xml [docutils]

started appearing after #9648 was merged. When warnings are treated like errors this causes the documentation builds to fail. This PR fixes these warnings.

@therock-pr-bot

Copy link
Copy Markdown

❌ PR Check — Action Required

Check Status Details
📝 PR Description ❌ Fail Error: PR description must reference a JIRA ID, ISSUE ID, or a GitHub closing keyword.
Expected: include a JIRA ID / ISSUE ID line (separator : or -, or omitted; value may be a JIRA key, a number with/without #, or a link), OR a closing keyword + issue reference. Accepted examples:
• JIRA ID : TESTAUTO-6039
• JIRA ID - #330
• JIRA ID #330
• JIRA ID (on separate line)
ROCM-25757
• ISSUE ID : TESTUTO-3334
• ISSUE ID #3334
• ISSUE ID - TESTAUTO-3433
• ISSUE ID (on separate line)
AIRUNTIME-2352
• ISSUE ID : https://github.com/<org_name>/<repo_name>/issues/1234
• Closes #10
• Fixes octo-org/octo-repo#100
• Resolves: #123
• #123
• https://github.com/<org_name>/<repo_name>/issues/123
Current: no valid JIRA/ISSUE/closing-keyword reference found
⛔ 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 —

⚠️ 1 policy check(s) failed. Please address the issues above before this PR can be Reviewed.

🚫 Please fix the failed policies

  • ❌ PR Description

The Not ready to Review label was added to this PR. Once all policies pass, the label is removed automatically.

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

🙋 Wish to Override Policy?

@therock-pr-bot

Copy link
Copy Markdown

🚫 Please fix the failed policies before requesting reviews.

The following policy checks failed:

  • ❌ PR Description

The Not ready to Review label has been added to this PR.
Once all policies pass, the label will be removed automatically.

@kliegeois kliegeois left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the fix!

@jsandham
jsandham merged commit 1c1b5c3 into ROCm:develop Aug 10, 2026
32 of 35 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.

3 participants