Suppress doc build warnings #152

Activity

1. leofang

   added

   documentationImprovements or additions to documentationImprovements or additions to documentation

   P2Low priority - Nice to haveLow priority - Nice to have

   on Oct 10, 2024
2. leofang

   added this to the cuda-python 12-next, 11-next milestone on Oct 10, 2024
3. leofang

   added

   cuda.bindingsEverything related to the cuda.bindings moduleEverything related to the cuda.bindings module

   on Oct 10, 2024
4. leofang commented on Oct 12, 2024

   

   leofang

   on Oct 12, 2024

   MemberAuthor

   More actions

   An example warning

   /local/home/leof/dev/cuda-python/docs_src/docstring of cuda.bindings.driver.cuMemcpy2D:22: WARNING: more than one target found for cross-reference 'srcPitch': cuda.bindings.driver.CUDA_MEMCPY2D_st.srcPitch, cuda.bindings.driver.CUDA_MEMCPY3D_st.srcPitch, cuda.bindings.driver.CUDA_MEMCPY3D_PEER_st.srcPitch, cuda.bindings.driver.CUDA_MEMCPY2D_v2.srcPitch, cuda.bindings.driver.CUDA_MEMCPY2D.srcPitch, cuda.bindings.driver.CUDA_MEMCPY3D_v2.srcPitch, cuda.bindings.driver.CUDA_MEMCPY3D.srcPitch, cuda.bindings.driver.CUDA_MEMCPY3D_PEER_v1.srcPitch, cuda.bindings.driver.CUDA_MEMCPY3D_PEER.srcPitch [ref.python]
   
5. leofang commented on Oct 12, 2024

   

   leofang

   on Oct 12, 2024

   MemberAuthor

   More actions

   I believe this is a legitimate warning, as the raw docstring is :py:obj:`~.srcPitch`, which does not provide the struct name that the srcPitch member belongs to. However, there's nothing we can do as it's already missing from the original doc source:
   https://docs.nvidia.com/cuda/cuda-driver-api/group__CUDA__MEM.html#group__CUDA__MEM_1g27f885b30c34cc20a663a671dbf6fc27
   so we do need to find a way to just suppress such warnings...
6. leofang commented on Oct 12, 2024

   

   leofang

   on Oct 12, 2024

   MemberAuthor

   More actions

   @vzhurba01 this looks like a docgen bug:
   https://github.com/NVIDIA/cuda-python/blob/f9f67c8ba2698c56eede95fe1b55bca3ce26d9a4/cuda_bindings/cuda/bindings/driver.pyx.in#L31341

   Sphinx output:

   docstring of cuda.bindings.driver.cuStreamSynchronize:12: CRITICAL: Unexpected section title.
   
   Parameters
   ---------- [docutils]
   docstring of cuda.bindings.driver.cuStreamSynchronize:17: CRITICAL: Unexpected section title.
   
   Returns
   ------- [docutils]
   docstring of cuda.bindings.driver.cuStreamSynchronize:22: CRITICAL: Unexpected section title.
   
   See Also
   -------- [docutils]
   
7. leofang commented on Oct 12, 2024

   

   leofang

   on Oct 12, 2024

   MemberAuthor

   More actions

   This one too:
   https://github.com/NVIDIA/cuda-python/blob/f9f67c8ba2698c56eede95fe1b55bca3ce26d9a4/cuda_bindings/cuda/bindings/runtime.pyx.in#L20967

   Sphinx output:

   docstring of cuda.bindings.runtime.cudaMemcpy:19: CRITICAL: Unexpected section title.
   
   Parameters
   ---------- [docutils]
   docstring of cuda.bindings.runtime.cudaMemcpy:30: CRITICAL: Unexpected section title.
   
   Returns
   ------- [docutils]
   docstring of cuda.bindings.runtime.cudaMemcpy:35: CRITICAL: Unexpected section title.
   
   See Also
   -------- [docutils]
   
8. leofang

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

   eliminate warnings due to repeated or non-existent entries

   ...

   bfef5c3
9. leofang

   modified the milestones: cuda-python 12-next, 11-next, cuda-bindings parking lot on Jan 16, 2025
10. leofang

    added

    triageNeeds the team's attentionNeeds the team's attention

    on Jan 18, 2025
11. leofang

    modified the milestones: cuda-python 12.9.0 & 11.8.7, cuda-python parking lot on Mar 25, 2025
12. leofang

    modified the milestones: cuda-python 12-next, 11-next, cuda-python parking lot on May 8, 2025
13. leofang

    modified the milestones: cuda-python 13-next, 12-next, cuda-python parking lot on Aug 23, 2025
14. github-project-automation

    added this to CCCLon Aug 23, 2025
15. github-project-automation

    moved this to Todo in CCCLon Aug 23, 2025
16. rparolin

    removed

    triageNeeds the team's attentionNeeds the team's attention

    on Jan 19, 2026
17. rparolin

    removed this from the cuda.bindings backlog milestone on Apr 2, 2026