-
Notifications
You must be signed in to change notification settings - Fork 83
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
32 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Build the documentation | ||
|
||
1. Install the `cuda-bindings` package of the version that we need to document. | ||
2. Ensure the version is included in the [`versions.json`](./versions.json). | ||
3. Build the docs with `./build_docs.sh`. | ||
4. The html artifacts should be available under both `./build/html/latest` and `./build/html/<version>`. | ||
|
||
Alternatively, we can build all the docs at once by running [`cuda_python/docs/build_all_docs.sh`](`../../cuda_python/docs/build_all_docs.sh`). | ||
|
||
To publish the docs with the built version, it is important to note that the html files of older versions | ||
should be kept intact, in order for the version selection (through `versions.json`) to work. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Build the documentation | ||
|
||
1. Install the `cuda-core` package of the version that we need to document. | ||
2. Ensure the version is included in the [`versions.json`](./versions.json). | ||
3. Build the docs with `./build_docs.sh`. | ||
4. The html artifacts should be available under both `./build/html/latest` and `./build/html/<version>`. | ||
|
||
Alternatively, we can build all the docs at once by running [`cuda_python/docs/build_all_docs.sh`](`../../cuda_python/docs/build_all_docs.sh`). | ||
|
||
To publish the docs with the built version, it is important to note that the html files of older versions | ||
should be kept intact, in order for the version selection (through `versions.json`) to work. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Build the documentation | ||
|
||
1. Ensure the version is included in the [`versions.json`](./versions.json). | ||
2. Build the docs with `./build_docs.sh`. | ||
3. The html artifacts should be available under both `./build/html/latest` and `./build/html/<version>`. | ||
|
||
Alternatively, we can build all the docs at once by running [`./build_all_docs.sh`](`./build_all_docs.sh`). | ||
|
||
To publish the docs with the built version, it is important to note that the html files of older versions | ||
should be kept intact, in order for the version selection (through `versions.json`) to work. |