mirror of https://github.com/lancedb/lancedb.git synced 2025-12-25 22:29:58 +00:00

Files

Ayush Chaurasia 64a4f025bb [Docs]: Minor Fixes (#587 )

* Filename typo
* Remove rick_morty csv as users won't really be able to use it.. We can
create a an executable colab and download it from a bucket or smth.

2023-10-20 16:14:35 +02:00

overrides/partials

[docs] CTA for discord + twitter (#218 )

2023-06-22 16:52:34 -07:00

src

[Docs]: Minor Fixes (#587 )

2023-10-20 16:14:35 +02:00

test

[DOCS][PYTHON] Update embeddings API docs & Example (#516 )

2023-10-14 07:56:07 +05:30

mkdocs.yml

[Docs] Embeddings API: Add multi-lingual semantic search example (#582 )

2023-10-20 18:40:49 +05:30

README.md

doc: fix broken link and add README (#573 )

2023-10-16 16:13:07 -07:00

requirements.txt

fix requirements

2023-06-26 12:25:29 -07:00

README.md

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

Install LanceDB. From LanceDB repo root: pip install -e python
Install dependencies. From LanceDB repo root: pip install -r docs/requirements.txt
Make sure you have node and npm setup
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.