From 74da9854b1a0bef648c7f3c3191cd3e6730a25f4 Mon Sep 17 00:00:00 2001 From: Ziwen Liu <67518483+ziw-liu@users.noreply.github.com> Date: Wed, 5 Jul 2023 00:07:20 -0700 Subject: [PATCH] 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 --- docs/make.jl | 2 +- docs/src/reference.md | 17 +++++++++++++---- 2 files changed, 14 insertions(+), 5 deletions(-) diff --git a/docs/make.jl b/docs/make.jl index ff45df0..96b1701 100644 --- 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 index 0ec9c65..f9d4402 100644 --- 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"] ```