Skip to content

Commit 288a55b

Browse files
Copilotleofang
andcommitted
Update cuda-core and cuda-bindings README to reference nv-versions.json
Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>
1 parent 237df56 commit 288a55b

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

cuda_bindings/docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Build the documentation
22

33
1. Install the `cuda-bindings` package of the version that we need to document.
4-
2. Ensure the version is included in the [`versions.json`](./versions.json).
4+
2. Ensure the version is included in the [`nv-versions.json`](./nv-versions.json).
55
3. Build the docs with `./build_docs.sh`.
66
4. The html artifacts should be available under both `./build/html/latest` and `./build/html/<version>`.
77

88
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).
99

1010
To publish the docs with the built version, it is important to note that the html files of older versions
11-
should be kept intact, in order for the version selection (through `versions.json`) to work.
11+
should be kept intact, in order for the version selection (through `nv-versions.json`) to work.

cuda_core/docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Build the documentation
22

33
1. Install the `cuda-core` package of the version that we need to document.
4-
2. Ensure the version is included in the [`versions.json`](./versions.json).
4+
2. Ensure the version is included in the [`nv-versions.json`](./nv-versions.json).
55
3. Build the docs with `./build_docs.sh`.
66
4. The html artifacts should be available under both `./build/html/latest` and `./build/html/<version>`.
77

88
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).
99

1010
To publish the docs with the built version, it is important to note that the html files of older versions
11-
should be kept intact, in order for the version selection (through `versions.json`) to work.
11+
should be kept intact, in order for the version selection (through `nv-versions.json`) to work.

0 commit comments

Comments
 (0)