Skip to content

Commit a17e0b9

Browse files
Copilotleofang
andcommitted
Restore original README.md files in docs directories as requested
Co-authored-by: leofang <[email protected]>
1 parent 83d9fd6 commit a17e0b9

File tree

6 files changed

+45
-47
lines changed

6 files changed

+45
-47
lines changed

cuda_bindings/docs/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Build the documentation
2+
3+
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).
5+
3. Build the docs with `./build_docs.sh`.
6+
4. The html artifacts should be available under both `./build/html/latest` and `./build/html/<version>`.
7+
8+
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).
9+
10+
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.

cuda_bindings/docs/README.rst

Lines changed: 0 additions & 11 deletions
This file was deleted.

cuda_core/docs/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Build the documentation
2+
3+
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).
5+
3. Build the docs with `./build_docs.sh`.
6+
4. The html artifacts should be available under both `./build/html/latest` and `./build/html/<version>`.
7+
8+
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).
9+
10+
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.

cuda_core/docs/README.rst

Lines changed: 0 additions & 11 deletions
This file was deleted.

cuda_python/docs/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Build the documentation
2+
3+
1. Ensure the version is included in the [`versions.json`](./versions.json).
4+
2. Build the docs with `./build_docs.sh`.
5+
3. The html artifacts should be available under both `./build/html/latest` and `./build/html/<version>`.
6+
7+
Alternatively, we can build all the docs at once by running [`./build_all_docs.sh`](./build_all_docs.sh).
8+
9+
When building the docs, some (but not all) of the urls can be rendered/examined locally by setting the environment
10+
variable `CUDA_PYTHON_DOMAIN` as follows:
11+
```shell
12+
CUDA_PYTHON_DOMAIN="http://localhost:1234/" ./build_all_docs.sh
13+
python -m http.server -d build/html 1234
14+
```
15+
If the docs are built on a remote machine, you can set up the ssh tunnel in a separate terminal session
16+
via
17+
```shell
18+
ssh -L 1234:localhost:1234 username@hostname
19+
```
20+
Then browse the built docs by visiting `http://localhost:1234/` on a local machine.
21+
22+
To publish the docs with the built version, it is important to note that the html files of older versions
23+
should be kept intact, in order for the version selection (through `versions.json`) to work.

cuda_python/docs/README.rst

Lines changed: 0 additions & 25 deletions
This file was deleted.

0 commit comments

Comments
 (0)