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.

Sign up for GitHub

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

Jump to bottom

[REVIEW] Use documented header template for doxygen #773

Merged
merged 3 commits into from
Aug 2, 2022
Merged

[REVIEW] Use documented header template for doxygen #773

merged 3 commits 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

This PR also utilizes centralized js & css added here: rapidsai/docs#286

@galipremsagar galipremsagar requested a review from a team as a code owner August 2, 2022 19:06
@github-actions github-actions bot added the cpp label Aug 2, 2022
@galipremsagar galipremsagar mentioned this pull request Aug 2, 2022
Merged
@galipremsagar galipremsagar added improvement Improvement / enhancement to an existing function non-breaking Non-breaking change labels Aug 2, 2022
@ajschmidt8 ajschmidt8 added doc Documentation and removed improvement Improvement / enhancement to an existing function labels Aug 2, 2022
@cjnolet
Copy link
Member

cjnolet commented Aug 2, 2022

Looks like there's a tiny failure in the docs build:

16:12:12 running build_ext
16:12:12 [1/1] Generate doxygen docs
16:12:12 FAILED: CMakeFiles/docs_raft /workspace/cpp/build/CMakeFiles/docs_raft 
16:12:12 cd /workspace/cpp/build && /opt/conda/envs/rapids/bin/doxygen /workspace/cpp/build/Doxyfile
16:12:12 error: tag HTML_HEADER: header file 'header.html' does not exist
16:12:12 Exiting...
16:12:12 ninja: build stopped: subcommand failed.
16:12:12 Build step 'Execute shell' marked build as failure

@galipremsagar
Copy link
Contributor Author

Looks like there's a tiny failure in the docs build:

16:12:12 running build_ext
16:12:12 [1/1] Generate doxygen docs
16:12:12 FAILED: CMakeFiles/docs_raft /workspace/cpp/build/CMakeFiles/docs_raft 
16:12:12 cd /workspace/cpp/build && /opt/conda/envs/rapids/bin/doxygen /workspace/cpp/build/Doxyfile
16:12:12 error: tag HTML_HEADER: header file 'header.html' does not exist
16:12:12 Exiting...
16:12:12 ninja: build stopped: subcommand failed.
16:12:12 Build step 'Execute shell' marked build as failure

Pushed a fix, hopefully should resolve the issue.

@cjnolet
Copy link
Member

cjnolet commented Aug 2, 2022

@gpucibot merge

@rapids-bot rapids-bot bot merged commit 3def727 into rapidsai:branch-22.08 Aug 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ajschmidt8 ajschmidt8 ajschmidt8 approved these changes

@cjnolet cjnolet cjnolet approved these changes

Assignees
No one assigned
Labels
cpp doc Documentation non-breaking Non-breaking change
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@galipremsagar @cjnolet @ajschmidt8