Skip to content

Commit

Permalink
[FEA] Make pylibcudf docs more visible
Browse files Browse the repository at this point in the history
  • Loading branch information
Matt711 committed Jan 24, 2025
1 parent b65ad08 commit e5231b5
Show file tree
Hide file tree
Showing 93 changed files with 16 additions and 6 deletions.
1 change: 0 additions & 1 deletion docs/cudf/source/developer_guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,5 @@ documentation
testing
benchmarking
options
pylibcudf
cudf_pandas
```
2 changes: 2 additions & 0 deletions docs/cudf/source/developer_guide/library_design.md
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,8 @@ To have each worker in dask print spill statistics, do something like:

## The Cython layer

> **_NOTE:_** Most of the functionality in the Cython layer has been moved to pylibcudf. All that remains is the Column layer which will be removed in a future release.

The lowest level of cuDF is its interaction with `libcudf` via Cython.
The Cython layer is composed of two components: C++ bindings and Cython wrappers.
The first component consists of [`.pxd` files](https://cython.readthedocs.io/en/latest/src/tutorial/pxd_files.html),
Expand Down
1 change: 1 addition & 0 deletions docs/cudf/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,6 @@ other operations.
user_guide/index
cudf_pandas/index
cudf_polars/index
pylibcudf/index
libcudf_docs/index
developer_guide/index
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
=========
pylibcudf
=========
=============
API Reference
=============

This page provides API documentation for pylibcudf.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# pylibcudf
# Developer Documentation

pylibcudf is a lightweight Cython wrapper around libcudf.
It aims to provide a near-zero overhead interface to accessing libcudf in Python.
Expand Down
9 changes: 9 additions & 0 deletions docs/cudf/source/pylibcudf/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
pylibcudf documentation
=======================

.. toctree::
:maxdepth: 2
:caption: Contents:

api_docs/index.rst
developer_docs
1 change: 0 additions & 1 deletion docs/cudf/source/user_guide/api_docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,4 @@ This page provides a list of all publicly accessible modules, methods and classe
struct_handling
options
extension_dtypes
pylibcudf/index.rst
performance_tracking

0 comments on commit e5231b5

Please sign in to comment.