mirror of https://github.com/lancedb/lancedb.git synced 2026-01-10 22:02:58 +00:00

Files

Bengsoon Chuah c00af75d63 Add relevant imports for each step (#764 )

I found that it was quite incoherent to have to read through the
documentation and having to search which submodule that each class
should be imported from.

For example, it is cumbersome to have to navigate to another
documentation page to find out that `EmbeddingFunctionRegistry` is from
`lancedb.embeddings`

2024-04-05 16:25:02 -07:00

overrides/partials

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

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

src

Add relevant imports for each step (#764 )

2024-04-05 16:25:02 -07:00

test

doc: add doc to use GPU for indexing (#611 )

2024-04-05 16:22:59 -07:00

mkdocs.yml

SaaS JS API sdk doc (#740 )

2024-04-05 16:25:02 -07:00

README.md

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

2024-04-05 16:22:59 -07:00

requirements.txt

feat(python): add option to flatten output in to_pandas (#722 )

2024-04-05 16:24:30 -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.