Skip to content

Bump verison of autoapi used to build docs #2177

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

Merged
merged 6 commits into from
Sep 29, 2024

Conversation

dstansby
Copy link
Contributor

@dstansby dstansby commented Sep 11, 2024

  • Bumps the version of autoapi we use to build the docs
  • Pins specific versions of sphinx and autoapi, which can then be updated by dependabot. I think it's best to pin the doc build to specific versions?
  • Simplifies the logic of excluding private members from the docs. This is a workaround to __all__ not respected when going from 3.0.0 to 3.1.0 readthedocs/sphinx-autoapi#481, but I think worth having regardless as a simplification of conf.py.

On the last point, this does mean that zarr.v2 and zarr.core are now in the API docs, but I figure we can think about making them private by appending a _ to the beginning in follow up PRs where we can decided where we want the various bits of API to actually live.

@dstansby dstansby marked this pull request as ready for review September 12, 2024 14:39
@jhamman
Copy link
Member

jhamman commented Sep 13, 2024

The plan is to remove the v2 namespace here soon so I wouldn't worry too much about that one. I'm also fine renaming core to _core if that helps here.

@jhamman jhamman added this to the 3.0.0 milestone Sep 13, 2024
@jhamman jhamman added the V3 label Sep 13, 2024
@dstansby
Copy link
Contributor Author

👍 - I think maybe lets get this in, then rename core > _core in another PR (it will be a big diff with all the changed imports!). Or perhaps once this is merged, we can review the public API and as part of that decide what to do with core.

@jhamman
Copy link
Member

jhamman commented Sep 24, 2024

@dstansby - is this ready for a merge?

@dstansby
Copy link
Contributor Author

Yep

@jhamman jhamman merged commit 6454c69 into zarr-developers:v3 Sep 29, 2024
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants