-
Notifications
You must be signed in to change notification settings - Fork 135
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
Rework the documentation to be build with sphinx #1753
Conversation
🟩 CI Results [ Failed: 0 | Passed: 198 | Total: 198 ]
|
# | Runner |
---|---|
154 | linux-amd64-cpu16 |
16 | linux-arm64-cpu16 |
16 | linux-amd64-gpu-v100-latest-1 |
12 | windows-amd64-cpu16 |
👃 Inspect Changes
Modifications in project?
Project | |
---|---|
CCCL Infrastructure | |
libcu++ | |
+/- | CUB |
+/- | Thrust |
CUDA Experimental |
Modifications in project or dependencies?
Project | |
---|---|
CCCL Infrastructure | |
libcu++ | |
+/- | CUB |
+/- | Thrust |
CUDA Experimental |
448e513
to
f3cee3c
Compare
🟨 CI Results: Pass: 99%/302 | Total Time: 3d 16h | Avg Time: 17m 32s | Hits: 83%/368738
|
# | Runner |
---|---|
232 | linux-amd64-cpu16 |
28 | linux-amd64-gpu-v100-latest-1 |
24 | linux-arm64-cpu16 |
18 | windows-amd64-cpu16 |
👃 Inspect Changes
Modifications in project?
Project | |
---|---|
CCCL Infrastructure | |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
CUDA Experimental |
Modifications in project or dependencies?
Project | |
---|---|
CCCL Infrastructure | |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
+/- | CUDA Experimental |
Can we rename/merge the |
Of course, initially I wanted to keep things parallel first so that I can compare output. I might be behind that stage though |
🟩 CI Results: Pass: 100%/302 | Total Time: 2d 13h | Avg Time: 12m 12s | Hits: 90%/369251
|
# | Runner |
---|---|
232 | linux-amd64-cpu16 |
28 | linux-amd64-gpu-v100-latest-1 |
24 | linux-arm64-cpu16 |
18 | windows-amd64-cpu16 |
👃 Inspect Changes
Modifications in project?
Project | |
---|---|
CCCL Infrastructure | |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
CUDA Experimental |
Modifications in project or dependencies?
Project | |
---|---|
CCCL Infrastructure | |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
+/- | CUDA Experimental |
5fc0603
to
72a781a
Compare
🟩 CI Results: Pass: 100%/306 | Total Time: 1d 13h | Avg Time: 7m 26s | Hits: 95%/369251
|
# | Runner |
---|---|
232 | linux-amd64-cpu16 |
32 | linux-amd64-gpu-v100-latest-1 |
24 | linux-arm64-cpu16 |
18 | windows-amd64-cpu16 |
👃 Inspect Changes
Modifications in project?
Project | |
---|---|
+/- | CCCL Infrastructure |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
CUDA Experimental |
Modifications in project or dependencies?
Project | |
---|---|
+/- | CCCL Infrastructure |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
+/- | CUDA Experimental |
🟩 CI Results: Pass: 100%/306 | Total Time: 2d 17h | Avg Time: 12m 52s | Hits: 97%/369251
|
# | Runner |
---|---|
232 | linux-amd64-cpu16 |
32 | linux-amd64-gpu-v100-latest-1 |
24 | linux-arm64-cpu16 |
18 | windows-amd64-cpu16 |
👃 Inspect Changes
Modifications in project?
Project | |
---|---|
+/- | CCCL Infrastructure |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
CUDA Experimental |
Modifications in project or dependencies?
Project | |
---|---|
+/- | CCCL Infrastructure |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
+/- | CUDA Experimental |
🟩 CI Results: Pass: 100%/306 | Total Time: 2d 11h | Avg Time: 11m 34s | Hits: 98%/369251
|
# | Runner |
---|---|
232 | linux-amd64-cpu16 |
32 | linux-amd64-gpu-v100-latest-1 |
24 | linux-arm64-cpu16 |
18 | windows-amd64-cpu16 |
👃 Inspect Changes
Modifications in project?
Project | |
---|---|
+/- | CCCL Infrastructure |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
CUDA Experimental |
Modifications in project or dependencies?
Project | |
---|---|
+/- | CCCL Infrastructure |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
+/- | CUDA Experimental |
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.
I cannot imagine how much work this must have been and how little fun it msut have been. That said, for the pages that I have reviewed, the current PR is not an improvement. Comments below.
Some pages are empty and do not have a placeholder table of contents. Examples:
- https://miscco.github.io/cccl/libcudacxx/ptx/examples.html
- https://miscco.github.io/cccl/libcudacxx/ptx/instructions.html
Stream ref page is shown as part of extended api tree:
PTX instruction pages:
- Some instruction variants have been compressed into a single entry. An example is
fence.acq_rel.cluster;
, which is listed as being available fromPTX ISA 60, SM_70
now (it should have been2. PTX ISA 78, SM_90
). - Table of contents at top of page are missing. This can be really useful for instructions with many variants.
- Tables relating C++ functions to and from PTX instructions have been removed.
Compare:
🟩 CI Results: Pass: 100%/306 | Total Time: 1d 18h | Avg Time: 8m 19s | Hits: 97%/369251
|
# | Runner |
---|---|
232 | linux-amd64-cpu16 |
32 | linux-amd64-gpu-v100-latest-1 |
24 | linux-arm64-cpu16 |
18 | windows-amd64-cpu16 |
👃 Inspect Changes
Modifications in project?
Project | |
---|---|
+/- | CCCL Infrastructure |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
CUDA Experimental |
Modifications in project or dependencies?
Project | |
---|---|
+/- | CCCL Infrastructure |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
+/- | CUDA Experimental |
@miscco can we split this up until multiple PRs? As is, this is basically unreviewable because the GitHub UI slows to a crawl when trying to open the diff page. Maybe something like:
|
063a490
to
2beb205
Compare
I squashed the PR into the respective three commits. You should be able to look at them by selecting the individual commit See for example ff556bf?diff=split&w=1 |
🟨 CI Results: Pass: 99%/306 | Total Time: 2d 15h | Avg Time: 12m 28s | Hits: 72%/383275
|
# | Runner |
---|---|
232 | linux-amd64-cpu16 |
32 | linux-amd64-gpu-v100-latest-1 |
24 | linux-arm64-cpu16 |
18 | windows-amd64-cpu16 |
👃 Inspect Changes
Modifications in project?
Project | |
---|---|
+/- | CCCL Infrastructure |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
CUDA Experimental |
Modifications in project or dependencies?
Project | |
---|---|
+/- | CCCL Infrastructure |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
+/- | CUDA Experimental |
ffaf374
to
1bf52e0
Compare
🟩 CI Results: Pass: 100%/306 | Total Time: 1d 18h | Avg Time: 8m 20s | Hits: 92%/383788
|
# | Runner |
---|---|
232 | linux-amd64-cpu16 |
32 | linux-amd64-gpu-v100-latest-1 |
24 | linux-arm64-cpu16 |
18 | windows-amd64-cpu16 |
👃 Inspect Changes
Modifications in project?
Project | |
---|---|
+/- | CCCL Infrastructure |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
CUDA Experimental |
Modifications in project or dependencies?
Project | |
---|---|
+/- | CCCL Infrastructure |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
+/- | CUDA Experimental |
🟩 CI Results: Pass: 100%/306 | Total Time: 1d 17h | Avg Time: 8m 06s | Hits: 93%/383788
|
# | Runner |
---|---|
232 | linux-amd64-cpu16 |
32 | linux-amd64-gpu-v100-latest-1 |
24 | linux-arm64-cpu16 |
18 | windows-amd64-cpu16 |
👃 Inspect Changes
Modifications in project?
Project | |
---|---|
+/- | CCCL Infrastructure |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
CUDA Experimental |
Modifications in project or dependencies?
Project | |
---|---|
+/- | CCCL Infrastructure |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
+/- | CUDA Experimental |
|
🟩 CI Results: Pass: 100%/365 | Total Time: 5d 13h | Avg Time: 21m 53s | Hits: 75%/522045
|
Project | |
---|---|
+/- | CCCL Infrastructure |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
CUDA Experimental |
Modifications in project or dependencies?
Project | |
---|---|
+/- | CCCL Infrastructure |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
+/- | CUDA Experimental |
🏃 Runner counts (total jobs: 365)
# | Runner |
---|---|
264 | linux-amd64-cpu16 |
56 | linux-amd64-gpu-v100-latest-1 |
24 | linux-arm64-cpu16 |
21 | windows-amd64-cpu16 |
🟨 CI Results: Pass: 90%/365 | Total Time: 1d 15h | Avg Time: 6m 30s | Hits: 95%/494813
|
Project | |
---|---|
+/- | CCCL Infrastructure |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
CUDA Experimental |
Modifications in project or dependencies?
Project | |
---|---|
+/- | CCCL Infrastructure |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
+/- | CUDA Experimental |
🏃 Runner counts (total jobs: 365)
# | Runner |
---|---|
264 | linux-amd64-cpu16 |
56 | linux-amd64-gpu-v100-latest-1 |
24 | linux-arm64-cpu16 |
21 | windows-amd64-cpu16 |
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.
Thank you for all the work! There's a number of broken links and minor comments below:
Co-authored-by: Georgii Evtushenko <[email protected]>
🟩 CI Results: Pass: 100%/365 | Total Time: 1d 20h | Avg Time: 7m 16s | Hits: 95%/522045
|
Project | |
---|---|
+/- | CCCL Infrastructure |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
CUDA Experimental |
Modifications in project or dependencies?
Project | |
---|---|
+/- | CCCL Infrastructure |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
+/- | CUDA Experimental |
🏃 Runner counts (total jobs: 365)
# | Runner |
---|---|
264 | linux-amd64-cpu16 |
56 | linux-amd64-gpu-v100-latest-1 |
24 | linux-arm64-cpu16 |
21 | windows-amd64-cpu16 |
repo_url = "https://github.com/NVIDIA/cccl" | ||
social_media_set = "" | ||
social_media = [ | ||
[ "github", "https://github.com/NVIDIA/cccl" ], |
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.
suggestion: if possible, I'd add our discord as well
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.
Discord is currently not in the supported list, I asked them whether we can add it
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.
One comment. Otherwise approved! Thanks for all the hard work!
@@ -0,0 +1,23 @@ | |||
.. _libcudacxx-ptx-instructions-elect-sync: |
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.
This file snuck through, but should not actually be included, as ptx::elect_sync
is not (yet) part of CCCL.
🟩 CI Results: Pass: 100%/365 | Total Time: 2d 01h | Avg Time: 8m 03s | Hits: 96%/522045
|
Project | |
---|---|
+/- | CCCL Infrastructure |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
CUDA Experimental |
Modifications in project or dependencies?
Project | |
---|---|
+/- | CCCL Infrastructure |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
+/- | CUDA Experimental |
🏃 Runner counts (total jobs: 365)
# | Runner |
---|---|
264 | linux-amd64-cpu16 |
56 | linux-amd64-gpu-v100-latest-1 |
24 | linux-arm64-cpu16 |
21 | windows-amd64-cpu16 |
🟩 CI Results: Pass: 100%/365 | Total Time: 1d 21h | Avg Time: 7m 27s | Hits: 97%/522045
|
Project | |
---|---|
+/- | CCCL Infrastructure |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
CUDA Experimental |
Modifications in project or dependencies?
Project | |
---|---|
+/- | CCCL Infrastructure |
+/- | libcu++ |
+/- | CUB |
+/- | Thrust |
+/- | CUDA Experimental |
🏃 Runner counts (total jobs: 365)
# | Runner |
---|---|
264 | linux-amd64-cpu16 |
56 | linux-amd64-gpu-v100-latest-1 |
24 | linux-arm64-cpu16 |
21 | windows-amd64-cpu16 |
This is a PoC for a unified documentation of the cccl repo utilizing repo_docs
The first PR moves the existing cub documentation to the top level
docs
folder. That requires us to adopt all paths in the in place documentation.The second commit moves the documentation of libcu++ to the top level
docs
folder. That requires us to move from markdown files to.rst
as otherwise most of the local links in the markdown file will be broken. The conversion was done throughpandoc --from=markdown --to=rst --output=index.rst index.md
. I also did a lot of manual improvements, e.g to tables and internal references.Finally the last commit moves thrust to the top level
docs
folder. Again markdown was transformed to.rst
to preserve links.The documentation of the thrust API is not as good as it was before, but that is something we should address in a followup PR.