Xuanwo
77af3bd746
Packages passed through `@udf(code=[...])` silently omit non-Python resources, so registration can appear successful before a worker fails to open a data file. Warn during function preparation with the omitted paths and document the source-only boundary next to `code=`. The diagnostic explains how to install a distribution that includes the data and remove the package from `code=` to avoid shadowing that installation. Python cache files do not produce warnings. Excluded directories are reported at their boundary, preserving the existing traversal and Python-source artifact format. This implements the warning-and-documentation alternative in ENT-3492; it does not add resource uploads. On EC2, the regression fails on baseline `f9389f113` because no warning is emitted; all 60 packaging tests pass at `e23445b96`, using the matching native extension built from unchanged Rust sources. CI-scoped Python lint with Ruff 0.9.9 passes. Whole-site Mintlify validation reports the same four snippet-import warnings on the baseline and this head; repository-root Ruff likewise reports the same 48 findings under `docs/web-tests`. These checks are not clean passes, but their failures do not involve this change. Fixes ENT-3492
LanceDB Documentation
For website guides in docs/web, start with
Documentation in CONTRIBUTING.md. That
covers editing pages, generated examples, previews, availability and drafts.
This page covers the SDK reference in docs/src, built with MkDocs. Its
GitHub Actions workflow builds and deploys on
pushes to main, so it can include unreleased APIs. That is separate from the
release editions of the Mintlify website.
Building the docs
Setup
- Install LanceDB Python. See setup in Python contributing guide.
Run
make developto install the Python package. - Install documentation dependencies. From LanceDB repo root:
pip install -r docs/requirements.txt
Preview the docs
Run these commands from the LanceDB repository root. The subshell changes into
docs to load mkdocs.yml, while leaving your shell in the repository root.
(cd docs && PYTHONPATH=. mkdocs serve)
If you want to just generate the HTML files:
(cd docs && PYTHONPATH=. mkdocs build)
If successful, you should see a docs/site directory in the repository root that
you can verify locally.
Adding examples
To make sure examples are correct, we put examples in test files so they can be run as part of our test suites.
You can see the tests are at:
- Python:
python/python/tests/docs - Typescript:
nodejs/examples/
Checking python examples
cd python
pytest -vv python/tests/docs
Checking typescript examples
The examples depend on @lancedb/lancedb at file:../dist, so the package must be
built before running the tests. This uses pnpm; see the
Typescript contributing guide for the toolchain setup.
pushd nodejs
pnpm install
pnpm build
popd
Then you can run the examples by going to the nodejs/examples directory, which is a
separate pnpm package with its own lockfile:
pushd nodejs/examples
pnpm install
pnpm test
popd
API documentation
Python
The Python API documentation is organized based on the file docs/src/python/python.md.
We manually add entries there so we can control the organization of the reference page.
However, this means any new types must be manually added to the file. No additional
steps are needed to generate the API documentation.
Typescript
The typescript API documentation is generated from the typescript source code using typedoc.
When new APIs are added, you must manually re-run the typedoc command to update the API documentation. The new files should be checked into the repository.
pushd nodejs
# `pnpm docs` would invoke pnpm's built-in `docs` command, not the script.
pnpm run docs
popd