TileDB-Py API Documentation

The TileDB-Py API documentation is hosted under a readthedocs subscription at stable and latest.

The readthedocs admin page is available here (Stavros and Seth are admins). This page hosts a variety of options including control of which versions of the documentation are built (in order to maintain historical API version docs).

The most important configuration settings are set in .readthedocs.yml, including the sphinx config path, the python version, and the prerequisites install step.

Local Build

To build locally, use the following script which will create a virtualenv with requirements and then generate HTML:

cd doc
./local-build.sh --tiledb=</path/to/libTileDB/dist

Troubleshooting

If you get this error

./local-build.sh: TileDB-Py/doc/venv/bin/pip: TileDB-Py/doc/venv/bin/python: bad interpreter: No such file or directory
could not install doc dependencies

Remove the venv directory and try installing again.

rm -rf venv