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

Activity

1. wence-

   added

   bugSomething isn't workingSomething isn't working

   docDocumentationDocumentation

   on Oct 9, 2024
2. wence-

   self-assigned this

   on Oct 9, 2024
3. github-project-automation

   added this to RMM Project Boardon Oct 9, 2024
4. github-project-automation

   moved this to Todo in RMM Project Boardon Oct 9, 2024
5. wence-

   moved this from Todo to In Progress in RMM Project Boardon Oct 9, 2024
6. wence-

   added a commit that references this issue on Oct 9, 2024

   Update cross-link to cuda-python object

   ...

   This issue will close once commit 530e03a is merged into the 'branch-23.04' branch.

   530e03a
7. leofang commented on Oct 9, 2024

   

   leofang

   on Oct 9, 2024

   Member

   More actions

   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?
8. charlesbluca commented on Oct 9, 2024

   

   charlesbluca

   on Oct 9, 2024

   Member

   More actions

   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
   
9. wence- commented on Oct 9, 2024

   

   wence-

   on Oct 9, 2024

   Last edited by wence-

   ContributorAuthor

   More actions

   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.
10. leofang commented on Oct 9, 2024

    

    leofang

    on Oct 9, 2024

    Member

    More actions

    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.
11. rapids-bot

    closed this as completedin #1699on Oct 9, 2024
12. rapids-bot

    closed this as completedin 4e519bbon Oct 9, 2024
13. github-project-automation

    moved this from In Progress to Done in RMM Project Boardon Oct 9, 2024
14. github-project-automation

    moved this from In Progress to Done in RMM Project Boardon Oct 9, 2024
15. wence-

    added a commit that references this issue on Oct 9, 2024

    Update cross-link to cuda-python object (rapidsai#1699)

    ...

    This issue will close once commit 4e519bb is merged into the 'branch-23.04' branch.

    4e519bb