Skip to content

Commit 8dc29fc

Browse files
committed
Add API Reference landing page
1 parent 55a0438 commit 8dc29fc

2 files changed

Lines changed: 19 additions & 0 deletions

File tree

fern/docs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,7 @@ navigation:
259259
- page: "Contributing"
260260
path: "./pages/contributing.md"
261261
- section: "API Reference"
262+
path: "./pages/api_reference.md"
262263
contents:
263264
- section: "C API Documentation"
264265
path: "./pages/c_api/index.md"

fern/pages/api_reference.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
slug: api-reference
3+
---
4+
5+
# API Reference
6+
7+
Use these generated references to inspect NVIDIA cuVS APIs by language. These pages are generated from the public source code and are best for checking signatures, parameters, return types, types, and language-specific API surfaces.
8+
9+
For task-focused examples and usage guidance, see the [API Guide](/user-guide/api-guides).
10+
11+
## Language References
12+
13+
- [C API Documentation](/api-reference/c-api-documentation): inspect the ABI-stable C API layer used by NVIDIA cuVS language bindings and downstream integrations.
14+
- [C++ API Documentation](/api-reference/cpp-api-documentation): inspect the core NVIDIA cuVS C++ APIs, including common RAFT types used in public headers.
15+
- [Python API Documentation](/api-reference/python-api-documentation): inspect Python modules, classes, functions, and parameters.
16+
- [Java API Documentation](/api-reference/java-api-documentation): inspect Java classes, resources, matrices, indexes, and query APIs.
17+
- [Rust API Documentation](/api-reference/rust-api-documentation): inspect Rust modules, structs, and wrappers around NVIDIA cuVS APIs.
18+
- [Go API Documentation](/api-reference/go-api-documentation): inspect Go packages for supported NVIDIA cuVS APIs.

0 commit comments

Comments
 (0)