Files
lancedb/docs
Chang She 72b39432e8 feat(python): add exist_ok option to create table (#813)
This mimics CREATE TABLE IF NOT EXISTS behavior.
We add `db.create_table(..., exist_ok=True)` parameter.
By default it is set to False, so trying to create
a table with the same name will raise an exception.
If set to True, then it only opens the table if it
already exists. If you pass in a schema, it will
be checked against the existing table to make sure
you get what you want. If you pass in data, it will
NOT be added to the existing table.
2024-04-05 16:26:35 -07:00
..
2024-04-05 16:24:47 -07:00

LanceDB Documentation

LanceDB docs are deployed to https://lancedb.github.io/lancedb/.

Docs is built and deployed automatically by Github Actions whenever a commit is pushed to the main branch. So it is possible for the docs to show unreleased features.

Building the docs

Setup

  1. Install LanceDB. From LanceDB repo root: pip install -e python
  2. Install dependencies. From LanceDB repo root: pip install -r docs/requirements.txt
  3. Make sure you have node and npm setup
  4. Make sure protobuf and libssl are installed

Building node module and create markdown files

See Javascript docs README

Build docs

From LanceDB repo root:

Run: PYTHONPATH=. mkdocs build -f docs/mkdocs.yml

If successful, you should see a docs/site directory that you can verify locally.