Skip to content

Commit b06f381

Browse files
committed
Move ffi-table-provider example to ffi-library and correct doc building
1 parent ae3bcda commit b06f381

File tree

17 files changed

+39
-40
lines changed

17 files changed

+39
-40
lines changed

.github/workflows/test.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ jobs:
9191
9292
- name: FFI unit tests
9393
run: |
94-
cd examples/ffi-table-provider
94+
cd examples/ffi-library
9595
uv run --no-project maturin develop --uv
9696
uv run --no-project pytest python/tests/_test_table_provider.py
9797

docs/source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@
7171
autoapi_member_order = "groupwise"
7272
suppress_warnings = ["autoapi.python_import_resolution"]
7373
autoapi_python_class_content = "both"
74+
autoapi_keep_files = False # Set to True for debugging documentation generated
7475

7576

7677
def autoapi_skip_member_fn(app, what, name, obj, skip, options) -> bool: # noqa: ARG001

docs/source/contributor-guide/ffi.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ By convention the ``datafusion-python`` library expects a Python object that has
176176
``TableProvider`` PyCapsule to have this capsule accessible by calling a function named
177177
``__datafusion_table_provider__``. You can see a complete working example of how to
178178
share a ``TableProvider`` from one python library to DataFusion Python in the
179-
`repository examples folder <https://github.com/apache/datafusion-python/tree/main/examples/ffi-table-provider>`_.
179+
`repository examples folder <https://github.com/apache/datafusion-python/tree/main/examples/ffi-library>`_.
180180

181181
This section has been written using ``TableProvider`` as an example. It is the first
182182
extension that has been written using this approach and the most thoroughly implemented.

examples/ffi-table-provider/Cargo.toml renamed to examples/ffi-library/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
# under the License.
1717

1818
[package]
19-
name = "ffi-table-provider"
19+
name = "ffi-library"
2020
version = "0.1.0"
2121
edition = "2021"
2222

File renamed without changes.

0 commit comments

Comments
 (0)