Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
leofang opened this issue Oct 9, 2024 · 1 comment
Open
Labels
documentation Improvements or additions to documentation

Comments

@leofang
Copy link
Member

leofang commented Oct 9, 2024

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 sphinx-doc/sphinx#10794 & sphinx-doc/sphinx#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 rapidsai/rmm#1698 (comment)

@leofang leofang added the documentation Improvements or additions to documentation label Oct 9, 2024
@leofang
Copy link
Member Author

leofang commented Oct 9, 2024

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"...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant