Skip to content

Commit

Permalink
Move to cccl/docs
Browse files Browse the repository at this point in the history
  • Loading branch information
miscco committed May 24, 2024
1 parent fe3b430 commit 5fc0603
Show file tree
Hide file tree
Showing 151 changed files with 29 additions and 256 deletions.
28 changes: 14 additions & 14 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,38 +32,38 @@ jobs:

# Build helper image for Thrust/CUB
- name: Build helper image
run: |
bash ./docs/make_env.bash "cccl:docs"
run: bash ./docs/make_env.bash "cccl:docs"

# Build all docs
- name: Build all docs
run: ./docs/gen_docs.bash

# Build top level docs for CCCL
- name: Build landing page
uses: actions/jekyll-build-pages@v1
with:
source: ./docs/jekyll
source: ./docs/_build/docs/cccl/latest
destination: ./_site

# CUB
- name: Build CUB docs
run: |
bash ./docs/build_docs.bash "cccl:docs" /cccl/cub/docs/gen_docs.bash
sudo mkdir -p ./_site/cub
sudo cp -rf ./cub/docs/_build/docs/CUB/latest/* ./_site/cub
# cub
- name: Build libcudacxx docs
uses: actions/jekyll-build-pages@v1
with:
source: ./docs/_build/docs/cub/latest
destination: ./_site/cub

# Libcudacxx
- name: Build libcudacxx docs
uses: actions/jekyll-build-pages@v1
with:
source: ./libcudacxx/docs
source: ./docs/_build/docs/libcudacxx/latest
destination: ./_site/libcudacxx

# Thrust
- name: Build Thrust markdown in Docker
run: bash ./docs/build_docs.bash "cccl:docs" /cccl/thrust/docs/build_docs_locally.bash

- name: Build Thrust docs
uses: actions/jekyll-build-pages@v1
with:
source: ./thrust/build_docs/github_pages
source: ./docs/_build/docs/thrust/latest
destination: ./_site/thrust

# Upload build artifacts
Expand Down
20 changes: 14 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Thank you for your interest in contributing to the CUDA C++ Core Libraries (CCCL
## Making Changes

1. **Create a New Branch**:

```bash
git checkout -b your-feature-branch
```
Expand All @@ -30,6 +31,7 @@ Thank you for your interest in contributing to the CUDA C++ Core Libraries (CCCL
./ci/build_[thrust|cub|libcudacxx].sh -cxx <HOST_COMPILER> -std <CXX_STANDARD> -arch <GPU_ARCHS>
./ci/test_[thrust|cub|libcudacxx].sh -cxx <HOST_COMPILER> -std <CXX_STANDARD> -arch <GPU_ARCHS>
```
For more details on building and testing, refer to the [Building and Testing](#building-and-testing) section below.
4. **Commit Changes**:
Expand All @@ -43,15 +45,18 @@ Thank you for your interest in contributing to the CUDA C++ Core Libraries (CCCL
For more information about design and development practices for each CCCL component, refer to the following developer guides:
#### CUB
- [CUB Developer Guide](cub/docs/developer_overview.rst) - General overview of the design of CUB internals
- [CUB Test Overview](cub/docs/test_overview.rst) - Overview of how to write CUB unit tests
- [CUB Tuning Infrastructure](cub/docs/tuning.rst) - Overview of CUB's performance tuning infrastructure
- [CUB Benchmarks](cub/docs/benchmarking.rst) - Overview of CUB's performance benchmarks
- [CUB Developer Guide](docs/cub/developer_overview.rst) - General overview of the design of CUB internals
- [CUB Test Overview](docs/cub/test_overview.rst) - Overview of how to write CUB unit tests
- [CUB Tuning Infrastructure](docs/cub/tuning.rst) - Overview of CUB's performance tuning infrastructure
- [CUB Benchmarks](docs/cub/benchmarking.rst) - Overview of CUB's performance benchmarks
#### Thrust
Coming soon!
#### libcudacxx
Coming soon!
## Building and Testing
Expand All @@ -61,6 +66,7 @@ CCCL components are header-only libraries. This means there isn't a traditional
There are multiple options for building and running our tests. Which option you choose depends on your preferences and whether you are using [CCCL's DevContainers](.devcontainer/README.md) (highly recommended!).

### Using Manual Build Scripts

#### Building

Use the build scripts provided in the `ci/` directory to build tests for each component. Building tests does not require a GPU.
Expand Down Expand Up @@ -89,6 +95,7 @@ Use the test scripts provided in the `ci/` directory to run tests for each compo
```

**Example:**

```bash
./ci/test_cub.sh -cxx g++ -std 14 -arch "70;75;80-virtual"
```
Expand Down Expand Up @@ -139,7 +146,7 @@ As a common example, the presets are currently always `60;70;80` for `CMAKE_CUDA
cmake --preset=thrust-cpp20 "-DCMAKE_CUDA_ARCHITECTURES=89"
```

> __Note__: Either using the `cmake` command from within the root directory or from within the build directory works, but will behave in slightly different ways. Building and running tests from the build directory will compile every target and run all of the tests configured in the configure step. Doing so from the root directory using the `--preset=<test_preset>` option will build and run a subset of configured targets and tests.
> **Note**: Either using the `cmake` command from within the root directory or from within the build directory works, but will behave in slightly different ways. Building and running tests from the build directory will compile every target and run all of the tests configured in the configure step. Doing so from the root directory using the `--preset=<test_preset>` option will build and run a subset of configured targets and tests.
#### Using CMake Presets via VS Code GUI extension (Recommended when using DevContainers)

Expand Down Expand Up @@ -233,9 +240,10 @@ Once submitted, maintainers will be automatically assigned to review the pull re
For constructive feedback and effective communication during reviews, we recommend following [Conventional Comments](https://conventionalcomments.org/).

Further recommended reading for successful PR reviews:

- [How to Do Code Reviews Like a Human (Part One)](https://mtlynch.io/human-code-reviews-1/)
- [How to Do Code Reviews Like a Human (Part Two)](https://mtlynch.io/human-code-reviews-2/)

## Thank You!
## Thank You

Your contributions enhance CCCL for the entire community. We appreciate your effort and collaboration!
File renamed without changes.
18 changes: 0 additions & 18 deletions docs/Dockerfile

This file was deleted.

File renamed without changes.
21 changes: 0 additions & 21 deletions docs/build_docs.bash

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
30 changes: 0 additions & 30 deletions docs/jekyll/_config.yaml

This file was deleted.

125 changes: 0 additions & 125 deletions docs/jekyll/_sass/color_schemes/nvidia.scss

This file was deleted.

Binary file removed docs/jekyll/favicon.ico
Binary file not shown.
Binary file removed docs/jekyll/images/nvidia_logo.png
Binary file not shown.
5 changes: 0 additions & 5 deletions docs/jekyll/index.md

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
13 changes: 0 additions & 13 deletions docs/make_env.bash

This file was deleted.

23 changes: 0 additions & 23 deletions docs/readme.md

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion thrust/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ git clone --recursive https://github.com/NVIDIA/thrust.git

## Using Thrust From Your Project

For CMake-based projects, we provide a CMake package for use with `find_package`. See the [CMake README](https://github.com/NVIDIA/cccl/blob/main/thrust/docs/github_pages/setup/cmake_options.md) for more information.
For CMake-based projects, we provide a CMake package for use with `find_package`. See the [CMake README](https://github.com/NVIDIA/cccl/blob/main/docs/thrust/github_pages/setup/cmake_options.md) for more information.
Thrust can also be added via `add_subdirectory` or tools like the [CMake Package Manager](https://github.com/cpm-cmake/CPM.cmake).

For non-CMake projects, compile with:
Expand Down

0 comments on commit 5fc0603

Please sign in to comment.