Skip to content

Commit

Permalink
add README
Browse files Browse the repository at this point in the history
  • Loading branch information
leofang committed Oct 15, 2024
1 parent 80099db commit 201fdc2
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 0 deletions.
11 changes: 11 additions & 0 deletions cuda_bindings/docs/README.md
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.
11 changes: 11 additions & 0 deletions cuda_core/docs/README.md
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.
10 changes: 10 additions & 0 deletions cuda_python/docs/README.md
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.

0 comments on commit 201fdc2

Please sign in to comment.