zarr-developers / zarr-python

An implementation of chunked, compressed, N-dimensional arrays for Python.
http://zarr.readthedocs.io/
MIT License
1.41k stars 267 forks source link

Autogenerate all API docs #2002

Open dstansby opened 2 weeks ago

dstansby commented 2 weeks ago

This updates the doc build to automatically generate all API docs. I've set it so any module with a part that starts with "_" is not documented, so that's the way to make a sub-module private.

This is currently erroring because zarr.array, zarr.group, and zarr.config are all both functions defined in zarr, and sub-modules. I think this should be solved to avoid name conflicts, but not sure the best way to do this. My guess is we should rename the functions to something like zarr.create_array or zarr.load_array, but could someone else advise?

Fixes https://github.com/zarr-developers/zarr-python/issues/1993.