-
Notifications
You must be signed in to change notification settings - Fork 158
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
Conversation
@@ -0,0 +1,62 @@ | |||
<!-- HTML header for doxygen 1.8.20--> |
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.
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.
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.
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
.
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.
Thanks for adding this to cuSpatial!
@galipremsagar is this ready to merge? |
Yes Mark, was waiting for approval. |
@gpucibot merge |
@gpucibot merge |
Thanks Mark! |
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_cssxref: rapidsai/cudf#11430