NVIDIA / NVIDIA/cuda-python

Suppress doc build warnings

Open
#152 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

cuda.bindings documentation P2
Dominant language
Cython
Stars
3.4k
Forks
329
Avg merge
1d 23h
Merged PRs (30d)
116

Description

According to @vzhurba01 the warnings are mostly due to the fact that some types are shared (?) across multiple modules and they are benign. Would be nice to figure out a way to suppress this particular warning, so that other warnings are not cluttered in-between and become noise.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running the documentation build and identifying the warning attributed to types shared across multiple modules. Trace how warnings are configured and confirm that only this benign warning is suppressed while other warnings remain visible. Done means the documentation build is quieter without masking unrelated warnings.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.