Improve API reference doc structure

Author: dstansby

.gitignore

@@ -51,7 +51,7 @@ coverage.xml
 
 # Sphinx documentation
 docs/_build/
-docs/_autoapi
+docs/api
 docs/data
 data
 data.zip

docs/Makefile

@@ -52,7 +52,7 @@ help:
 .PHONY: clean
 clean:
 	rm -rf $(BUILDDIR)/*
-	rm -rf $(BUILDDIR)/../_autoapi
+	rm -rf $(BUILDDIR)/../api
 
 .PHONY: html
 html:

docs/api/index.rst

@@ -57,7 +57,7 @@
 autoapi_add_toctree_entry = False
 autoapi_generate_api_docs = True
 autoapi_member_order = "groupwise"
-autoapi_root = "_autoapi"
+autoapi_root = "api"
 autoapi_keep_files = True
 autoapi_options = [ 'members', 'undoc-members', 'show-inheritance', 'show-module-summary', 'imported-members', ]
 
@@ -104,6 +104,7 @@ def skip_submodules(
      "spec/v3": "https://zarr-specs.readthedocs.io/en/latest/v3/core/v3.0.html",
      "license": "https://github.com/zarr-developers/zarr-python/blob/main/LICENSE.txt",
      "tutorial": "user-guide",
+     "api": "api/zarr/index"
 }
 
 # The language for content autogenerated by Sphinx. Refer to documentation

docs/conf.py

@@ -11,7 +11,7 @@ Zarr-Python
     getting_started
     about
     user-guide/index
-    api/index
+    API Reference <api/zarr/index>
     release
     contributing
     roadmap
@@ -80,12 +80,12 @@ Zarr is a file storage format for chunked, compressed, N-dimensional arrays base
 
         +++
 
-        .. button-ref:: api/index
+        .. button-ref:: api/zarr/index
             :expand:
             :color: dark
             :click-parent:
 
-            To the api reference guide
+            To the API reference
 
     .. grid-item-card::
         :img-top: _static/index_contribute.svg