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

[REVIEW] Use documented header template for doxygen #619

Merged
merged 1 commit into from
Aug 2, 2022

Conversation

galipremsagar
Copy link
Contributor

This PR uses a documented template auto-generated by doxygen and inserts our custom js & css links to it. The process is documented here: https://doxygen.nl/manual/customize.html#minor_tweaks_header_css

xref: rapidsai/cudf#11430

@galipremsagar galipremsagar requested a review from a team as a code owner August 2, 2022 16:33
@github-actions github-actions bot added the libcuspatial Relates to the cuSpatial C++ library label Aug 2, 2022
@ajschmidt8 ajschmidt8 added doc Documentation non-breaking Non-breaking change labels Aug 2, 2022
@@ -0,0 +1,62 @@
<!-- HTML header for doxygen 1.8.20-->
Copy link
Contributor

@isVoid isVoid Aug 2, 2022

Choose a reason for hiding this comment

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

Sorry I'm a bit late to the review process. The content of this file doesn't seem specific to cuspatial (and other RAPIDS library). Any reason this cannot be included in rapidsai/docs?

I thought about auto generating this file in the doxygen build scripts and automate the injection of the RAPIDS actions and stylesheets. But perhaps a bit brittle if doxygen updates their generate process.

Copy link
Contributor Author

@galipremsagar galipremsagar Aug 2, 2022

Choose a reason for hiding this comment

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

Sorry I'm a bit late to the review process. The content of this file doesn't seem specific to cuspatial (and other RAPIDS library). Any reason this cannot be included in rapidsai/docs?

That's unfortunately not possible because the doxygen builds happen at the repository level and not in rapidsai/docs. We also want to fetch the css styles during the local docs build too, hence this file can't stay in rapidsai/docs.

Copy link
Member

@harrism harrism left a comment

Choose a reason for hiding this comment

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

Thanks for adding this to cuSpatial!

@harrism
Copy link
Member

harrism commented Aug 2, 2022

@galipremsagar is this ready to merge?

@galipremsagar
Copy link
Contributor Author

galipremsagar commented Aug 2, 2022

@galipremsagar is this ready to merge?

Yes Mark, was waiting for approval.

@galipremsagar
Copy link
Contributor Author

@gpucibot merge

@galipremsagar
Copy link
Contributor Author

@gpucibot merge

Don't think I have permissions, could you merge it @harrism ?

@harrism
Copy link
Member

harrism commented Aug 2, 2022

@gpucibot merge

@rapids-bot rapids-bot bot merged commit 803e662 into rapidsai:branch-22.08 Aug 2, 2022
@galipremsagar
Copy link
Contributor Author

Thanks Mark!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation libcuspatial Relates to the cuSpatial C++ library non-breaking Non-breaking change
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants