Setup documentation and corresponding github action #1118
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wmaxey
commented
Nov 17, 2023
| - name: Build CUB docs | ||
| run: | | ||
| bash ./docs/build_docs.bash "cccl:docs" /cccl/cub/docs/gen_docs.bash | ||
| sudo mkdir -p ./_site/cub |
There was a problem hiding this comment.
I don't know why, but I couldn't figure out the permissions for the output directory. We need sudo to allow writing into it.
e14b1ad
to
022b701
Compare
jrhemstad
reviewed
Nov 20, 2023
| Prepare docker container for local builds | ||
|
|
||
| ```bash | ||
| make_env.bash $TAG |
There was a problem hiding this comment.
question: What is $TAG?
suggestion: Document what $TAG is, and if relevant, possible values.
There was a problem hiding this comment.
Literally the tag for the image that Thrust/CUB shares for building, but yeah, I'll do that.
08c478e
to
b903958
Compare
|
/ok to test |
jrhemstad
approved these changes
Nov 30, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
closes #53
This PR allows building our documentation.
Currently CUB has some failures, these can be ignored for the time being. It seems that Doxygen/Sphinx does its best to create something useable even if there's a build failure.
Libcudacxx/Thrust required a bit of fenagling to point to the right base URL.
There is a top level CCCL build that just indexes the libraries... We can make this better later.
You can see the output of the latest commit here: https://wmaxey.github.io/cccl/
Checklist