Skip to content

Conversation

@dstansby
Copy link
Contributor

@dstansby dstansby commented Jan 3, 2025

This improves the structure of the API reference by:

  • Generating the pages under api/, instead of redirecting from an index page under api/ to _autoapi/
  • Adding a redirect from the v2 API page to the new page
  • Before you had to click on "API reference", then "zarr" on the following (mostly empty) page to get to the ref. Now "API reference" links directly to the API reference page.

@dstansby dstansby added the documentation Improvements to the documentation label Jan 3, 2025
@jhamman
Copy link
Member

jhamman commented Jan 3, 2025

Great improvement. Happy to approve once this is ready for review.

@dstansby dstansby marked this pull request as ready for review January 4, 2025 09:27
@dstansby dstansby requested a review from jhamman January 5, 2025 10:32
@jhamman jhamman enabled auto-merge (squash) January 6, 2025 04:29
@jhamman jhamman merged commit ec014f6 into zarr-developers:main Jan 6, 2025
28 checks passed
@dstansby dstansby deleted the api-doc-struct branch January 6, 2025 10:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements to the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants