Add codec categories in doc contents (#458)

* Add codec categories in doc contents * Improve contents structure * Put registry in API * Add release note * Move pcodec
zarr-developers · Sep 1, 2024 · d42bac9 · d42bac9
1 parent a8f6efb
commit d42bac9
Show file tree

Hide file tree

Showing 28 changed files with 58 additions and 27 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -0,0 +1,12 @@
+API reference
+=============
+
+.. toctree::
+    :maxdepth: 2
+
+    compression/index
+    filter/index
+    other/index
+    checksum32
+    abc
+    registry
diff --git a/docs/checksum32.rst b/docs/checksum32.rst
@@ -1,5 +1,5 @@
-32-bit checksums
-================
+Checksum codecs
+===============
 .. automodule:: numcodecs.checksum32
 
 CRC32
@@ -37,7 +37,7 @@ JenkinsLookup3
 --------------
 
 .. autoclass:: JenkinsLookup3
-    
+
     .. autoattribute:: codec_id
     .. autoattribute:: initval
     .. autoattribute:: prefix

diff --git a/docs/blosc.rst → docs/compression/blosc.rst b/docs/blosc.rst → docs/compression/blosc.rst
diff --git a/docs/bz2.rst → docs/compression/bz2.rst b/docs/bz2.rst → docs/compression/bz2.rst
diff --git a/docs/gzip.rst → docs/compression/gzip.rst b/docs/gzip.rst → docs/compression/gzip.rst
diff --git a/docs/compression/index.rst b/docs/compression/index.rst
@@ -0,0 +1,15 @@
+Compression codecs
+------------------
+
+.. toctree::
+    :maxdepth: 2
+
+    blosc
+    bz2
+    gzip
+    lzma
+    lz4
+    pcodec
+    zfpy
+    zlib
+    zstd
diff --git a/docs/lz4.rst → docs/compression/lz4.rst b/docs/lz4.rst → docs/compression/lz4.rst
diff --git a/docs/lzma.rst → docs/compression/lzma.rst b/docs/lzma.rst → docs/compression/lzma.rst
diff --git a/docs/pcodec.rst → docs/compression/pcodec.rst b/docs/pcodec.rst → docs/compression/pcodec.rst
diff --git a/docs/zfpy.rst → docs/compression/zfpy.rst b/docs/zfpy.rst → docs/compression/zfpy.rst
diff --git a/docs/zlib.rst → docs/compression/zlib.rst b/docs/zlib.rst → docs/compression/zlib.rst
diff --git a/docs/zstd.rst → docs/compression/zstd.rst b/docs/zstd.rst → docs/compression/zstd.rst
diff --git a/docs/astype.rst → docs/filter/astype.rst b/docs/astype.rst → docs/filter/astype.rst
diff --git a/docs/bitround.rst → docs/filter/bitround.rst b/docs/bitround.rst → docs/filter/bitround.rst
diff --git a/docs/categorize.rst → docs/filter/categorize.rst b/docs/categorize.rst → docs/filter/categorize.rst
diff --git a/docs/delta.rst → docs/filter/delta.rst b/docs/delta.rst → docs/filter/delta.rst
diff --git a/docs/fixedscaleoffset.rst → docs/filter/fixedscaleoffset.rst b/docs/fixedscaleoffset.rst → docs/filter/fixedscaleoffset.rst
diff --git a/docs/filter/index.rst b/docs/filter/index.rst
@@ -0,0 +1,14 @@
+Filter codecs
+-------------
+
+.. toctree::
+    :maxdepth: 2
+
+    delta
+    fixedscaleoffset
+    quantize
+    bitround
+    packbits
+    categorize
+    astype
+    shuffle
diff --git a/docs/packbits.rst → docs/filter/packbits.rst b/docs/packbits.rst → docs/filter/packbits.rst
diff --git a/docs/quantize.rst → docs/filter/quantize.rst b/docs/quantize.rst → docs/filter/quantize.rst
diff --git a/docs/shuffle.rst → docs/filter/shuffle.rst b/docs/shuffle.rst → docs/filter/shuffle.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -64,30 +64,7 @@ Contents
 .. toctree::
     :maxdepth: 2
 
-    abc
-    registry
-    blosc
-    pcodec
-    lz4
-    zfpy
-    zstd
-    zlib
-    gzip
-    bz2
-    lzma
-    delta
-    fixedscaleoffset
-    quantize
-    bitround
-    packbits
-    categorize
-    checksum32
-    astype
-    json
-    pickles
-    msgpacks
-    vlen
-    shuffle
+    api
     release
     contributing
 

diff --git a/docs/other/index.rst b/docs/other/index.rst
@@ -0,0 +1,11 @@
+Other codecs
+------------
+
+
+.. toctree::
+    :maxdepth: 2
+
+    json
+    pickles
+    msgpacks
+    vlen
diff --git a/docs/json.rst → docs/other/json.rst b/docs/json.rst → docs/other/json.rst
diff --git a/docs/msgpacks.rst → docs/other/msgpacks.rst b/docs/msgpacks.rst → docs/other/msgpacks.rst
diff --git a/docs/pickles.rst → docs/other/pickles.rst b/docs/pickles.rst → docs/other/pickles.rst
diff --git a/docs/vlen.rst → docs/other/vlen.rst b/docs/vlen.rst → docs/other/vlen.rst
diff --git a/docs/release.rst b/docs/release.rst
@@ -41,6 +41,8 @@ Enhancements
   By :user:`Ryan Abernathey <rabernat>`, :issue:`501`.
 * Use PyData theme for docs
   By :user:`John Kirkham <jakirkham>`, :issue:`485`.
+* Improve the structure of docs
+  By :user:`David Stansby <dstansby>`, :issue:`458`.
 
 Fix
 ~~~