Skip to content

Commit 1d0003d

Browse files
authored
Point C++ API docs to NVIDIA Sphinx sites (#835)
## Summary Route the libcudf, libkvikio, and librapidsmpf API cards from old Doxygen sites to the new Sphinx C++ documentation on docs.nvidia.com beginning with release 26.10. Older releases continue to use their existing docs.rapids.ai links, and migrated builds are no longer imported into the portal. Authors: - Bradley Dice (https://github.com/bdice) Approvers: - Naty Clementi (https://github.com/ncclementi) URL: #835
1 parent 46e6586 commit 1d0003d

4 files changed

Lines changed: 24 additions & 10 deletions

File tree

‎_data/docs.yml‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,8 @@ libs:
191191
libcudf:
192192
name: libcudf
193193
path: libcudf
194-
first_docs_nvidia_com_release: null
194+
first_docs_nvidia_com_release: "26.10"
195+
docs_nvidia_com_path: cudf/{version}/libcudf
195196
desc: 'libcudf is a C/C++ CUDA library for implementing standard dataframe operations.'
196197
ghlink: https://github.com/rapidsai/cudf
197198
cllink: https://github.com/rapidsai/cudf/blob/main/CHANGELOG.md
@@ -215,7 +216,8 @@ libs:
215216
libkvikio:
216217
name: libkvikio
217218
path: libkvikio
218-
first_docs_nvidia_com_release: null
219+
first_docs_nvidia_com_release: "26.10"
220+
docs_nvidia_com_path: kvikio/{version}/cpp
219221
desc: "libkvikio is a C++ header-only library providing bindings to cuFile, which enables GPUDirect Storage (GDS)."
220222
ghlink: https://github.com/rapidsai/kvikio
221223
cllink: https://github.com/rapidsai/kvikio/blob/main/CHANGELOG.md
@@ -227,7 +229,8 @@ libs:
227229
librapidsmpf:
228230
name: librapidsmpf
229231
path: librapidsmpf
230-
first_docs_nvidia_com_release: null
232+
first_docs_nvidia_com_release: "26.10"
233+
docs_nvidia_com_path: rapidsmpf/{version}/cpp
231234
desc: "librapidsmpf is a C++ collection of multi-GPU, distributed memory algorithms."
232235
ghlink: https://github.com/rapidsai/rapidsmpf
233236
versions:

‎ci/customization/projects-to-versions.json‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,7 @@
4848
},
4949
"libcudf": {
5050
"legacy": "26.06",
51-
"stable": "26.08",
52-
"nightly": "26.10"
51+
"stable": "26.08"
5352
},
5453
"libcuml": {
5554
"legacy": "26.06",
@@ -58,13 +57,11 @@
5857
},
5958
"libkvikio": {
6059
"legacy": "26.06",
61-
"stable": "26.08",
62-
"nightly": "26.10"
60+
"stable": "26.08"
6361
},
6462
"librapidsmpf": {
6563
"legacy": "26.06",
66-
"stable": "26.08",
67-
"nightly": "26.10"
64+
"stable": "26.08"
6865
},
6966
"libucxx": {
7067
"legacy": "0.50",

‎extensions/rapids_docs/routes.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ def _documentation_url(
3434
first_nvidia_release = project["first_docs_nvidia_com_release"]
3535
if first_nvidia_release and _version_tuple(version) >= _version_tuple(first_nvidia_release):
3636
target_version = "latest" if version_name == "nightly" else version
37-
base_url = f"https://docs.nvidia.com/{project['path']}/{target_version}/"
37+
path = project.get("docs_nvidia_com_path", f"{project['path']}/{{version}}")
38+
base_url = f"https://docs.nvidia.com/{path.format(version=target_version)}/"
3839
else:
3940
base_url = f"https://docs.rapids.ai/api/{project['path']}/{version_name}/"
4041
return _with_suffix(base_url, suffix)

‎tests/test_rendering.py‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,19 @@ def test_api_docs() -> None:
5454

5555
libs = api._api_docs(data, "libs")
5656
assert "https://docs.nvidia.com/rapids-cmake/latest/" in libs
57+
assert "https://docs.nvidia.com/cudf/latest/libcudf/" in libs
58+
assert "https://docs.nvidia.com/kvikio/latest/cpp/" in libs
59+
assert "https://docs.nvidia.com/rapidsmpf/latest/cpp/" in libs
60+
if tuple(map(int, stable_version.split("."))) <= (26, 8):
61+
assert f"[{stable_version}](https://docs.rapids.ai/api/libcudf/stable/)" in libs
62+
assert f"[{stable_version}](https://docs.rapids.ai/api/libkvikio/stable/)" in libs
63+
assert f"[{stable_version}](https://docs.rapids.ai/api/librapidsmpf/stable/)" in libs
64+
else:
65+
assert f"[{stable_version}](https://docs.nvidia.com/cudf/{stable_version}/libcudf/)" in libs
66+
assert f"[{stable_version}](https://docs.nvidia.com/kvikio/{stable_version}/cpp/)" in libs
67+
assert (
68+
f"[{stable_version}](https://docs.nvidia.com/rapidsmpf/{stable_version}/cpp/)" in libs
69+
)
5770
assert f"/{nightly_version}/" not in rendered + libs
5871

5972
inactive = api._api_docs(data, "inactive-projects")

0 commit comments

Comments
 (0)