mirror of
https://github.com/lancedb/lancedb.git
synced 2025-12-25 06:19:57 +00:00
bb01ad5290
Fix broken link to embedding functions testing: broken link was verified after local docs build to have been repaired --------- Co-authored-by: Chang She <chang@lancedb.com>
26 lines
856 B
Markdown
26 lines
856 B
Markdown
# LanceDB Documentation
|
|
|
|
LanceDB docs are deployed to https://lancedb.github.io/lancedb/.
|
|
|
|
Docs is built and deployed automatically by [Github Actions](.github/workflows/docs.yml)
|
|
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](docs/src/javascript/README.md)
|
|
|
|
### 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. |