Skip to content

Index UCXX docs #679

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jameslamb merged 8 commits into from
Sep 15, 2025
Merged

Index UCXX docs #679

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7ebfb18
Add UCXX
pentschev Sep 15, 2025
537e85a
Disable legacy/stable for now
pentschev Sep 15, 2025
1bbbbae
Remove legacy and stable versions
pentschev Sep 15, 2025
d1fded6
Fix comments again
pentschev Sep 15, 2025
c74bb0f
Update _data/docs.yml
jameslamb Sep 15, 2025
b3f7e58
Fix link formatting
pentschev Sep 15, 2025
6567d30
Clarify comment
pentschev Sep 15, 2025
1a77344
Fix name conditional
pentschev Sep 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion _data/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,19 @@ apis:
legacy: 0
stable: 1
nightly: 1
ucxx:
name: UCXX
path: ucxx
desc: 'UCXX is the Python interface for [UCX](https://github.com/openucx/ucx), a low-level high-performance networking library. UCX and UCXX support several transport methods including InfiniBand and NVLink while still using traditional networking protocols like TCP.'
ghlink: https://github.com/rapidsai/ucxx
cllink: https://github.com/rapidsai/ucxx/blob/main/CHANGELOG.md
versions:
# enable or disable links; 0 = disabled, 1 = enabled
# TODO: enable 'legacy' once ucxx legacy version moves to 0.46 in `_data/releases.json`
legacy: 0
# TODO: enable 'stable' once ucxx stable version moves to 0.46 in `_data/releases.json`
stable: 0
nightly: 1


# RAPIDS "Libs" - lower-level libraries that are building blocks for creating
Expand Down Expand Up @@ -197,7 +210,7 @@ libs:
libucxx:
name: libucxx
path: libucxx
desc: "UCXX is an object-oriented C++ interface for UCX, with native support for Python bindings."
desc: "libucxx is an object-oriented C++ interface for UCX, with native support for Python bindings."
ghlink: https://github.com/rapidsai/ucxx
versions:
# enable or disable links; 0 = disabled, 1 = enabled
Expand Down
2 changes: 1 addition & 1 deletion _includes/api-docs.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
#### DOCS {% for version_name in versions -%}
{%- if api.version-overrides -%}
**[{{ version_name }} ({{ api.version-overrides[version_name] }})](/api/{{ api.path }}/{{ version_name }})**
{%- elsif api.name == "libucxx" -%}
{%- elsif api.name | downcase contains "ucxx" -%}
**[{{ version_name }} ({{ site.data.releases[version_name].ucxx_version }})](/api/{{ api.path }}/{{ version_name }})**
{%- else -%}
**[{{ version_name }} ({{ site.data.releases[version_name].version }})](/api/{{ api.path }}/{{ version_name }})**
Expand Down
6 changes: 4 additions & 2 deletions _redirects
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@
/api/libkvikio/ /api/libkvikio/stable/
/api/librmm /api/rmm/stable/
/api/librmm/ /api/rmm/stable/
/api/libucxx /api/libucxx/stable/
/api/libucxx/ /api/libucxx/stable/
/api/raft /api/raft/stable/
/api/raft/ /api/raft/stable/
/api/rapids-cmake /api/rapids-cmake/stable/
Expand All @@ -40,10 +42,10 @@
/api/rapidsmpf/ /api/rapidsmpf/stable/
/api/rmm /api/rmm/stable/
/api/rmm/ /api/rmm/stable/
/api/ucxx /api/ucxx/stable/
/api/ucxx/ /api/ucxx/stable/
/deployment /deployment/stable/
/deployment/ /deployment/stable/
/api/libucxx /api/libucxx/stable/
/api/libucxx/ /api/libucxx/stable/
# redirects for zero-code-change -> cuml-accel rename, can be removed after 25.10 release
/api/cuml/stable/zero-code-change/ /api/cuml/stable/cuml-accel/
/api/cuml/stable/zero-code-change-benchmarks/ /api/cuml/stable/cuml-accel/benchmarks/
Expand Down
3 changes: 3 additions & 0 deletions ci/customization/projects-to-versions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@
"stable": "25.08",
"nightly": "25.10"
},
"ucxx": {
"nightly": "0.46"
},
"librmm": {
"legacy": "25.06",
"stable": "25.08",
Expand Down