search

NVIDIA / cuda-python

CUDA Python Low-level Bindings
https://nvidia.github.io/cuda-python/
Other
982 stars 76 forks source link

Cross references to old paths are gone in the latest CUDA Python docs #140

Open leofang opened 1 month ago

leofang commented 1 month ago

Although the modules are backwards compatible, the intersphinx mapping (objects.inv) only has the new module names in it.

Yeah seems to be the case

$ python -m sphinx.ext.intersphinx https://nvidia.github.io/cuda-python/objects.inv | grep cudaCpuDeviceId
    cuda.bindings.runtime.cudaCpuDeviceId                                            : module/runtime.html#cuda.bindings.runtime.cudaCpuDeviceId

and it seems to be a known limitation of Sphinx with aliased objects (maybe https://github.com/sphinx-doc/sphinx/issues/10794 & https://github.com/sphinx-doc/sphinx/issues/10151 are relevant).

We'll keep an eye on it, if it breaks too widely we'll need to figure out a workaround.

Originally posted by @leofang in https://github.com/rapidsai/rmm/issues/1698#issuecomment-2402835867

leofang commented 1 month ago

Let's wait and see how many projects rely on CUDA Python's objects.inv so that we can decide if this is a "won't fix"...