Build doxygen docs and push to GH pages via CI
Nobody has claimed this yet.
- Dominant language
- Cuda
- Stars
- 667
- Forks
- 120
- Avg merge
- 7d 5h
- Merged PRs (30d)
- 4
Description
While scrolling through the readme, I was reminded that the doxygen docs page is still a TODO. Let me check if we can abuse the CI to automatically build the docs and push to the project's GH.io page.
We can either utilize our beloved gpuCI with a custom script or GH actions: https://github.com/marketplace/actions/doxygen-action + https://github.com/peaceiris/actions-gh-pages
Originally posted by @sleeepyjack in https://github.com/NVIDIA/cuCollections/pull/214#issuecomment-1218424725
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the README's doxygen TODO and inspect the repository's existing gpuCI configuration, if present. Compare a custom gpuCI script with the named Doxygen and peaceiris/actions-gh-pages workflows; done means the documentation builds automatically and is published to the project's GitHub Pages site.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100