diff --git a/cuda_bindings/docs/README.md b/cuda_bindings/docs/README.md new file mode 100644 index 00000000..d0f01366 --- /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 00000000..d84c6880 --- /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 00000000..b8d5c440 --- /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.