From 201fdc2a2e0cf41381cbc5b346a8fd6e9f3af15a Mon Sep 17 00:00:00 2001 From: Leo Fang Date: Tue, 15 Oct 2024 19:19:48 +0000 Subject: [PATCH] add README --- cuda_bindings/docs/README.md | 11 +++++++++++ cuda_core/docs/README.md | 11 +++++++++++ cuda_python/docs/README.md | 10 ++++++++++ 3 files changed, 32 insertions(+) create mode 100644 cuda_bindings/docs/README.md create mode 100644 cuda_core/docs/README.md create mode 100644 cuda_python/docs/README.md diff --git a/cuda_bindings/docs/README.md b/cuda_bindings/docs/README.md new file mode 100644 index 000000000..d0f013665 --- /dev/null +++ b/cuda_bindings/docs/README.md @@ -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/`. + +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. diff --git a/cuda_core/docs/README.md b/cuda_core/docs/README.md new file mode 100644 index 000000000..d84c68809 --- /dev/null +++ b/cuda_core/docs/README.md @@ -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/`. + +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. diff --git a/cuda_python/docs/README.md b/cuda_python/docs/README.md new file mode 100644 index 000000000..b8d5c4402 --- /dev/null +++ b/cuda_python/docs/README.md @@ -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/`. + +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.