- Install the
cuda-corepackage of the version that we need to document. - Ensure the version is included in the
nv-versions.json. - Build the docs with
./build_docs.sh. - The html artifacts should be available under both
./build/html/latestand./build/html/<version>.
For local development, cuda_core/pixi.toml now includes a dedicated docs
environment that mirrors the CI Sphinx dependencies:
- From
cuda_core/, runpixi run docs-buildto build the full versioned docs output. - Run
pixi run docs-build-latestto iterate on just thelatestdocs. - Run
pixi run docs-debugfor a serial, verbose Sphinx build that is easier to debug.
Alternatively, we can build all the docs at once by running 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 nv-versions.json) to work.
