rust/lancedb
1
0
Fork 0
mirror of https://github.com/lancedb/lancedb.git synced 2026-01-05 19:32:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

restore material theme and add mkdocstring for autodoc etc

Browse Source
This commit is contained in:
Chang She
2023-03-22 17:45:51 -07:00
parent 242802ec74
commit aeb3c52c8c
5 changed files with 63 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/index.md
View File

@@ -17,3 +17,4 @@ LanceDB's core is written in Rust 🦀 and is built using Lance, an open-source
## Documentation Quick Links
* `Quick start` - search and filter a hello world vector dataset with LanceDB using the Python SDK.
* [`API Reference`](python.md) - detailed documentation for the LanceDB Python SDK.

12
docs/python.md Normal file
View File

@@ -0,0 +1,12 @@
# LanceDB Python API Reference
## Installation
```shell
pip install lancedb
```
::: lancedb
::: lancedb.db
::: lancedb.table
::: lancedb.query

3
docs/requirements.txt Normal file
View File

@@ -0,0 +1,3 @@
mkdocs==1.4.2
mkdocs-material==9.1.3
mkdocstrings[python]==0.20.0