docs: audit example coverage in published docs#1866
Conversation
cpcloud
added
cuda.bindings
This comment has been minimized.
This comment has been minimized.
| Introduction | ||
| ------------ | ||
|
|
||
| - `clock_nvrtc_test.py <https://github.com/NVIDIA/cuda-python/blob/main/cuda_bindings/examples/0_Introduction/clock_nvrtc_test.py>`_ |
There was a problem hiding this comment.
Do we want to link to main on github? I worry the examples could get out-of-sync with the docs or the API. We could:
Link to a specific tag
Since we already have a release config value, we can automate this like:
- `clock_nvrtc_test.py <https://github.com/NVIDIA/cuda-python/blob/|release|
/cuda_bindings/examples/0_Introduction/clock_nvrtc_test.py>`_
-- though we probably want to do something special in the conf.py to map a "latest" doc build to point to the "main" branch.
Include the files verbatim as pages in the docs
This could be mostly automated.
Ensure examples work across a range of versions
We should fix/augment our CI to make sure all the examples are tested against the range of supported versions. We are kind of there, but not quite.
There was a problem hiding this comment.
Updated this to use package-aware refs instead of hardcoding main. latest and preview builds now point at main, while versioned docs point at the matching package tag (cuda-core-v... for core and v... for bindings). I also refreshed the bindings filenames after rebasing onto #1847.
cuda_bindings/pixi.toml
Outdated
| myst-parser = "*" | ||
| numpy = "*" | ||
| numpydoc = "*" | ||
| pip = "*" |
There was a problem hiding this comment.
As I think I mentioned in the earlier PR -- this seems weird / potentially hazardous.
There was a problem hiding this comment.
Dropped the pixi docs env/task changes from this PR so it stays scoped to the docs coverage audit. The overlapping docs-workflow work can continue separately.
cpcloud
force-pushed
the
audit-examples-1680
branch
from
54127d9 to
286e0fc
Compare
cpcloud
changed the title
|
Rebased onto current |
Make every current cuda.core and cuda.bindings example discoverable from the published docs, and add a reproducible pixi-based docs workflow so documentation changes can be built and debugged locally. Made-with: Cursor
Point the new example links at package-aware refs instead of always targeting main, and drop the overlapping pixi docs workflow changes so this PR stays scoped to the documentation coverage audit. Made-with: Cursor
Keep the pixi lockfiles aligned with the current manifests after rebasing onto the merged docs workflow and verifying the docs tasks. Made-with: Cursor
cpcloud
force-pushed
the
audit-examples-1680
branch
from
ba5c28b to
659f20b
Compare
|
2 participants
Summary
examplespages forcuda.coreandcuda.bindingsso every shipped example is linked from the published docsstrided_memory_view.pyreference, and follow the snake_case bindings example rename from Fix #1841: Rename examples #1847latestand preview builds continue to point atmainTest plan
bash -n cuda_core/docs/build_docs.shbash -n cuda_bindings/docs/build_docs.shgit diff --checkcuda_core/examples/*.pyandcuda_bindings/examples/**/*.pyfiles after the Fix #1841: Rename examples #1847 renameCloses #1680.
Made with Cursor