Automatically generate API reference docs #1918
Conversation
dstansby
changed the title
dstansby
force-pushed
the
autoapi
branch
2 times, most recently
from
f649442 to
7cd3b56
Compare
|
I didn't review this in detail but i like the effort, and auto docs >>> no docs IMO |
|
thanks @dstansby ! |
|
Thanks all! 🙏 It looks like RTD is failing. Would someone here be able to take a look? 🙂 |
|
@jakirkham I'm not too familiar with RTD but I can try to sort things out. Can you elaborate on where the problem is evident? E.g., what should I be looking at? I checked https://zarr.readthedocs.io/en/v3/ and https://zarr.readthedocs.io/en/stable/, both look fine to me |
|
See the v3 builds at https://app.readthedocs.org/projects/zarr/builds/. #1985 should be a fix. |
|
Thank you both! 🙏 Yep David linked the right place to look. As RTD will just show the last successful build, looking at the doc pages themselves is unfortunately not as helpful. Maybe they could have a banner to note the doc builds or failing or something Have gone ahead and merged David's fix. Let's see if that helps 🍀 |
|
Fixed with PRs: Doc builds are now passing again! 🎉 |
* v3: (22 commits) [v3] `Buffer` ensure correct subclass based on the `BufferPrototype` argument (zarr-developers#1974) Fix doc build (zarr-developers#1987) Fix doc build warnings (zarr-developers#1985) Automatically generate API reference docs (zarr-developers#1918) Update `RemoteStore.__str__` and add UPath tests (zarr-developers#1964) [v3] Elevate codec pipeline (zarr-developers#1932) 0 dim arrays: indexing (zarr-developers#1980) `parse_shapelike` allows 0 (zarr-developers#1979) Clean up typing and docs for indexing (zarr-developers#1961) add json indentation to config (zarr-developers#1952) chore: update pre-commit hooks (zarr-developers#1973) Bump pypa/gh-action-pypi-publish in the actions group (zarr-developers#1969) chore: update pre-commit hooks (zarr-developers#1957) Update release.rst (zarr-developers#1960) doc: update release notes for 3.0.0.alpha (zarr-developers#1959) Basic working FsspecStore (zarr-developers#1785) Feature: Top level V3 API (zarr-developers#1884) Buffer Prototype Argument (zarr-developers#1910) Create issue-metrics.yml fixes bug in transpose (zarr-developers#1949) ...
This uses sphinx-autoapi to automatically generate API reference for v3, replacing a lot of manually created .rst pages that were present for v2. Currently only for the
zarrnamespace, but can (and should) be expanded to sub-modules in a follow up PR.See https://zarr--1918.org.readthedocs.build/en/1918/api/index.html for the current build of this PR; feedback welcome. There are definitely improvements to be made here, but I think worth getting this in as a first go at the API reference.