-
Notifications
You must be signed in to change notification settings - Fork 930
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Generate Doxygen Tag File for Libcudf #10932
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good. Thanks for linking the RMM example for comparison. This is almost exactly how intersphinx works, too. Those files (object.inv
) are generated by default.
Codecov Report
@@ Coverage Diff @@
## branch-22.08 #10932 +/- ##
================================================
+ Coverage 86.40% 87.38% +0.98%
================================================
Files 143 144 +1
Lines 22448 25148 +2700
================================================
+ Hits 19396 21976 +2580
- Misses 3052 3172 +120
Continue to review full report at Codecov.
|
@harrism should we bump this to 22.08 and then merge? It's a tiny change that almost certainly won't break anything, but it's also just helpful for devs so no point pushing it into 22.06 past code freeze IMO. |
It seems like nightly builds of the docs are available so I see no issue with punting this to 22.08 unless @isVoid needs this for cross-referencing docs in cuSpatial 22.06. |
Retargeted 22.08 |
rerun tests |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
@gpucibot merge |
A doxygen tag file is a compact representation of entries in the doxygen documentation. Doxygen can generate tag files and read tag files from external sources. Local test shows that including tag file for libcudf does not have visible impact on build time and the tag file size is manageable (~126KB).
This is similar to rmm tag file:
https://github.com/rapidsai/rmm/blob/c49493dea6caf7e8c840b1c83f20caa50de92d5f/doxygen/Doxyfile#L2084