Skip to content
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

Merged
merged 1 commit into from
Jun 6, 2022

Conversation

isVoid
Copy link
Contributor

@isVoid isVoid commented May 23, 2022

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

@isVoid isVoid requested a review from a team as a code owner May 23, 2022 18:43
@isVoid isVoid requested review from harrism and jrhemstad May 23, 2022 18:43
@github-actions github-actions bot added the libcudf Affects libcudf (C++/CUDA) code. label May 23, 2022
@isVoid isVoid added doc Documentation 3 - Ready for Review Ready for review by team non-breaking Non-breaking change improvement Improvement / enhancement to an existing function and removed improvement Improvement / enhancement to an existing function labels May 23, 2022
@isVoid isVoid self-assigned this May 23, 2022
Copy link
Contributor

@bdice bdice left a 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
Copy link

codecov bot commented May 23, 2022

Codecov Report

Merging #10932 (dfe1635) into branch-22.08 (8d861ce) will increase coverage by 0.98%.
The diff coverage is n/a.

@@               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     
Impacted Files Coverage Δ
...thon/dask_cudf/dask_cudf/tests/test_distributed.py 18.86% <0.00%> (-67.93%) ⬇️
python/cudf/cudf/io/parquet.py 90.83% <0.00%> (-1.87%) ⬇️
python/dask_cudf/dask_cudf/backends.py 85.25% <0.00%> (-1.19%) ⬇️
python/cudf/cudf/core/column/decimal.py 90.60% <0.00%> (-0.50%) ⬇️
python/cudf/cudf/core/column/lists.py 91.70% <0.00%> (-0.38%) ⬇️
python/cudf/cudf/core/scalar.py 89.01% <0.00%> (-0.31%) ⬇️
python/cudf/cudf/core/column/string.py 88.78% <0.00%> (-0.31%) ⬇️
python/cudf/cudf/core/index.py 92.06% <0.00%> (-0.25%) ⬇️
python/dask_cudf/dask_cudf/io/tests/test_s3.py 96.05% <0.00%> (-0.15%) ⬇️
python/cudf/cudf/utils/ioutils.py 79.47% <0.00%> (-0.13%) ⬇️
... and 29 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8d861ce...dfe1635. Read the comment docs.

@vyasr
Copy link
Contributor

vyasr commented May 25, 2022

@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.

@bdice
Copy link
Contributor

bdice commented May 25, 2022

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.

@isVoid isVoid changed the base branch from branch-22.06 to branch-22.08 June 3, 2022 23:33
@isVoid
Copy link
Contributor Author

isVoid commented Jun 3, 2022

Retargeted 22.08

@karthikeyann
Copy link
Contributor

rerun tests

Copy link
Contributor

@karthikeyann karthikeyann left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@isVoid
Copy link
Contributor Author

isVoid commented Jun 6, 2022

@gpucibot merge

@rapids-bot rapids-bot bot merged commit becf5c3 into rapidsai:branch-22.08 Jun 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Ready for Review Ready for review by team doc Documentation libcudf Affects libcudf (C++/CUDA) code. non-breaking Non-breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants