Repository navigation
[FEA]: Add a consistency check for cuda.core.__all__ vs cuda_core/docs/source/api.rst #2326
Description
xref: #2300 (review)
Copy-pasting the relevant part for easy referrence:
Add a follow-on docs/API consistency test that compares the public symbols in cuda.core.__all__ against the public entries in cuda_core/docs/source/api.rst, with deliberate exceptions for submodule namespaces and returned-helper/private API docs.
It should parse the Sphinx autosummary and data entries, then account for known surfaces such as cuda.core.graph, cuda.core.texture, cuda.core.utils, cuda.core.checkpoint, and entries intentionally documented in api_private.rst. The useful failure mode is: “this symbol is public by __all__ but missing from public docs” or “this symbol is documented as public but not exported by __all__.”
Activity
aryanputta commentedon Jul 12, 2026
I can take this. Plan:
cuda_core/tests/test_api_docs_consistency.pythat parsesdocs/source/api.rst(trackingcurrentmoduleso only flatcuda.coreautosummary entries and.. data::directives count, with dotted entries likegraph.Graphandcheckpoint.Processtreated as submodule namespaces) and compares the result againstcuda.core.__all__.api_private.rst(e.g._device_resources.DeviceResources) are accepted as documented so returned-helper docs do not fail the check.__all__but missing from public docs, or documented as public but not exported by__all__.cuda.core.__all__is not defined, so it is safe to land independently of Add griffe API checking to cuda_core #2300 and activates once Add griffe API checking to cuda_core #2300 merges.test(core): add cuda.core.__all__ vs public docs consistency check (N…
Prepare for 13.4.1 release (#2788)
Pull 13.4.1 changes into main (#2789)