Skip to content

Commit 80a6a82

Browse files
committed
Merge branch 'main' into experimental
2 parents 9839793 + d809deb commit 80a6a82

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

cuda_python/docs/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,18 @@
66

77
Alternatively, we can build all the docs at once by running [`./build_all_docs.sh`](./build_all_docs.sh).
88

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+
922
To publish the docs with the built version, it is important to note that the html files of older versions
1023
should be kept intact, in order for the version selection (through `versions.json`) to work.

cuda_python/docs/build_all_docs.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ pushd .
1313
cd ../../cuda_bindings/docs
1414
rm -rf build
1515
./build_docs.sh
16-
cp -r build/html/* "$(dirs +1)"/$CUDA_BINDINGS_PATH
16+
cp -r build/html/* "$(dirs -l +1)"/$CUDA_BINDINGS_PATH
1717
popd
1818

1919
# build cuda-core docs
@@ -23,5 +23,5 @@ pushd .
2323
cd ../../cuda_core/docs
2424
rm -rf build
2525
./build_docs.sh
26-
cp -r build/html/* "$(dirs +1)"/$CUDA_CORE_PATH
26+
cp -r build/html/* "$(dirs -l +1)"/$CUDA_CORE_PATH
2727
popd

0 commit comments

Comments
 (0)