Update API documentation page (#122)

* update API documentation page * add section for ZGroup * use autodocs block for Compressors to include all the types * rename API reference page
JuliaIO · Jul 5, 2023 · 74da985 · 74da985
1 parent b988d67
commit 74da985
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 5 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -9,7 +9,7 @@ makedocs(
     pages = [
         "Home" => "index.md",
         "Tutorial" => "tutorial.md",
-        "Function Reference" => "reference.md",
+        "API Reference" => "reference.md",
         "Storage Backends" => "storage.md",
         "Accessing cloud data Examples" => "s3examples.md",
         "Operations on Zarr Arrays" => "operations.md",

diff --git a/docs/src/reference.md b/docs/src/reference.md
@@ -1,13 +1,22 @@
-## Array creation
+# API reference
+
+## Arrays
 
 ```@docs
 zcreate
 zzeros
 ```
 
+## Group hierarchy
+
+```@autodocs
+Modules = [Zarr]
+Pages = ["ZGroup.jl"]
+```
+
 ## Compressors
 
-```@docs
-Zarr.BloscCompressor
-Zarr.NoCompressor
+```@autodocs
+Modules = [Zarr]
+Pages = ["Compressors.jl"]
 ```