- Ensure the version is included in the
versions.json. - Build the docs with
./build_docs.sh. - The html artifacts should be available under both
./build/html/latestand./build/html/<version>.
Alternatively, we can build all the docs at once by running ./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:
CUDA_PYTHON_DOMAIN="http://localhost:1234/" ./build_all_docs.sh
python -m http.server -d build/html 1234If the docs are built on a remote machine, you can set up the ssh tunnel in a separate terminal session via
ssh -L 1234:localhost:1234 username@hostnameThen 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.