Add C++ API reference to Sphinx docs - #8544
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (13)
Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review. 📝 WalkthroughSummary by CodeRabbit
WalkthroughChangesC++ API documentation
Estimated code review effort: 3 (Moderate) | ~20 minutes Merge Risk: ⚪ Minimal · up to This PR adds C++ API documentation and the required documentation dependency without introducing an identified correctness, security, availability, or deployment risk; no actionable merge-blocking risk remains after normal checks and review. Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Full details: Docstring CoverageExplanation Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. (12 skipped: 12 unsupported.)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
We don't currently consider the C++ api public in any way - I'd worry about the effect of publishing the docs for something that we make no promise is usable outside of the python library (and no promises of deprecations/no breaking changes). Personally I wouldn't want these docs to be published at this point.
cc @csadorf for another opinion.
Summary
Integrate cuML’s Doxygen-generated C++ API into the Sphinx documentation using Breathe. This adds namespace references for
ML,MLCommon, andcuml::geneticto the main documentation navigation and normalizes Doxygen 1.9.1 XML constructs that Sphinx cannot represent.