cuda-python/cuda_core/docs at main · Virtual0ps/cuda-python · GitHub
Skip to content

Latest commit

 

History

History
 
 

Folders and files

Build the documentation

  1. Install the cuda-core package of the version that we need to document.
  2. Ensure the version is included in the nv-versions.json.
  3. Build the docs with ./build_docs.sh.
  4. The html artifacts should be available under both ./build/html/latest and ./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/, run pixi run docs-build to build the full versioned docs output.
  • Run pixi run docs-build-latest to iterate on just the latest docs.
  • Run pixi run docs-debug for 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.