Skip to content

Commit

Permalink
address review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
leofang committed Oct 15, 2024
1 parent 75305fb commit fa8d482
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
13 changes: 13 additions & 0 deletions cuda_python/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,18 @@

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

When building the docs, some (but not all) of the urls can be rendered/examined locally by setting the environment
variable `CUDA_PYTHON_DOMAIN` as follows:
```shell
CUDA_PYTHON_DOMAIN="http://localhost:1234/" ./build_all_docs.sh
python -m http.server -d build/html 1234
```
If the docs are built on a remote machine, you can set up the ssh tunnel in a separate terminal session
via
```shell
ssh -L 1234:localhost:1234 username@hostname
```
Then browse the built docs by visiting `http://localhost:1234/` on a local machine.

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.
4 changes: 2 additions & 2 deletions cuda_python/docs/build_all_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ pushd .
cd ../../cuda_bindings/docs
rm -rf build
./build_docs.sh
cp -r build/html/* "$(dirs +1)"/$CUDA_BINDINGS_PATH
cp -r build/html/* "$(dirs -l +1)"/$CUDA_BINDINGS_PATH
popd

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

0 comments on commit fa8d482

Please sign in to comment.