wip: make the python API reference a bit nicer (#162)

Adds:

* Make `mkdocstrings` aware we are using numpy-style docstrings
* Fixes broken link on `index.md` to Python API docs (and added link to
node ones)
* Added examples to various classes.
* Added doctest to verify examples work.
This commit is contained in:
Will Jones
2023-06-08 16:07:06 -07:00
committed by GitHub
parent a56b65db84
commit fed33a51d5
14 changed files with 417 additions and 51 deletions

View File

@@ -35,6 +35,8 @@ jobs:
pip install pytest pytest-mock
- name: Run tests
run: pytest -x -v --durations=30 tests
- name: doctest
run: pytest --doctest-modules lancedb
mac:
timeout-minutes: 30
runs-on: "macos-12"