diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..64562eb6 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,26 @@ +# 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. \ No newline at end of file diff --git a/docs/src/index.md b/docs/src/index.md index 64eb8f87..a35f182f 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -67,7 +67,7 @@ LanceDB's core is written in Rust 🦀 and is built using