Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Autogenerate all API docs #2002

Draft
wants to merge 6 commits into
base: v3
Choose a base branch
from
Draft

Conversation

dstansby
Copy link
Contributor

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 #1993.

@jhamman jhamman added V3 Related to compatibility with V3 spec documentation Improvements to the documentation labels Jul 1, 2024
@jhamman jhamman added this to the 3.0.0 milestone Jul 1, 2024
@dstansby dstansby marked this pull request as draft July 23, 2024 09:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements to the documentation V3 Related to compatibility with V3 spec
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

Finish v3 API reference docs
2 participants