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

[BUG] Doc build failures due to cuda-python namespace rewrite #1698

Closed
wence- opened this issue Oct 9, 2024 · 4 comments · Fixed by #1699
Closed

[BUG] Doc build failures due to cuda-python namespace rewrite #1698

wence- opened this issue Oct 9, 2024 · 4 comments · Fixed by #1699
Assignees
Labels
bug Something isn't working doc Documentation

Comments

@wence-
Copy link
Contributor

wence- commented Oct 9, 2024

Describe the bug

Recently, the low-level cuda-python bindings were reorganised (see NVIDIA/cuda-python#137). Since the documentation is not versioned, and we cross-link a reference to cudaCpuDeviceId, it no longer resolves and the doc build breaks.

We should update the reference.

@wence- wence- added bug Something isn't working doc Documentation labels Oct 9, 2024
@wence- wence- self-assigned this Oct 9, 2024
@wence- wence- moved this from Todo to In Progress in RMM Project Board Oct 9, 2024
wence- added a commit to wence-/rmm that referenced this issue Oct 9, 2024
@leofang
Copy link
Member

leofang commented Oct 9, 2024

Hmmm this is unexpected as we meant to keep things fully backward compatible. The old modules still exist. @wence- do you have a CI log for the doc build issue that we can take a look at?

@charlesbluca
Copy link
Member

do you have a CI log for the doc build issue that we can take a look at?

Here's an example:

https://github.com/rapidsai/rmm/actions/runs/11248565164/job/31274194449

In particular the failure is

/__w/rmm/rmm/python/rmm/docs/docstring of rmm.pylibrmm.device_buffer.DeviceBuffer.prefetch:10: WARNING: py:attr reference target not found: cuda.cudart.cudaCpuDeviceId

@wence-
Copy link
Contributor Author

wence- commented Oct 9, 2024

Hmmm this is unexpected as we meant to keep things fully backward compatible. The old modules still exist. @wence- do you have a CI log for the doc build issue that we can take a look at?

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working doc Documentation
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants