Docs

Contributing to Documentation¶

The main documentation website is built using mkdocs-material. To build the docs, first install requirements:

cd docs
uc sync --dev

Then build and start the docs server:

uv run mkdocs serve

Python code documentation is built using Sphinx in lance-python-doc, and published through Github Pages in ReadTheDocs style.

Rust code documentation is built and published to the Rust official docs website as a part of the release process.

Java code documentation is built and published to Maven Central. You can find the doc page for the specific project at javadoc.io.