From 36f249e012ecec177bfb1824e7c8c2772150fefc Mon Sep 17 00:00:00 2001 From: David Stansby Date: Thu, 24 Aug 2023 17:39:32 +0100 Subject: [PATCH 1/5] Add codec categories in doc contents --- docs/checksum32.rst | 6 +++--- docs/{ => compression}/blosc.rst | 0 docs/{ => compression}/bz2.rst | 0 docs/{ => compression}/gzip.rst | 0 docs/compression/index.rst | 14 ++++++++++++++ docs/{ => compression}/lz4.rst | 0 docs/{ => compression}/lzma.rst | 0 docs/{ => compression}/zfpy.rst | 0 docs/{ => compression}/zlib.rst | 0 docs/{ => compression}/zstd.rst | 0 docs/{ => filter}/astype.rst | 0 docs/{ => filter}/bitround.rst | 0 docs/{ => filter}/categorize.rst | 0 docs/{ => filter}/delta.rst | 0 docs/{ => filter}/fixedscaleoffset.rst | 0 docs/filter/index.rst | 14 ++++++++++++++ docs/{ => filter}/packbits.rst | 0 docs/{ => filter}/quantize.rst | 0 docs/{ => filter}/shuffle.rst | 0 docs/index.rst | 25 ++++--------------------- docs/other/index.rst | 11 +++++++++++ docs/{ => other}/json.rst | 0 docs/{ => other}/msgpacks.rst | 0 docs/{ => other}/pickles.rst | 0 docs/{ => other}/vlen.rst | 0 25 files changed, 46 insertions(+), 24 deletions(-) rename docs/{ => compression}/blosc.rst (100%) rename docs/{ => compression}/bz2.rst (100%) rename docs/{ => compression}/gzip.rst (100%) create mode 100644 docs/compression/index.rst rename docs/{ => compression}/lz4.rst (100%) rename docs/{ => compression}/lzma.rst (100%) rename docs/{ => compression}/zfpy.rst (100%) rename docs/{ => compression}/zlib.rst (100%) rename docs/{ => compression}/zstd.rst (100%) rename docs/{ => filter}/astype.rst (100%) rename docs/{ => filter}/bitround.rst (100%) rename docs/{ => filter}/categorize.rst (100%) rename docs/{ => filter}/delta.rst (100%) rename docs/{ => filter}/fixedscaleoffset.rst (100%) create mode 100644 docs/filter/index.rst rename docs/{ => filter}/packbits.rst (100%) rename docs/{ => filter}/quantize.rst (100%) rename docs/{ => filter}/shuffle.rst (100%) create mode 100644 docs/other/index.rst rename docs/{ => other}/json.rst (100%) rename docs/{ => other}/msgpacks.rst (100%) rename docs/{ => other}/pickles.rst (100%) rename docs/{ => other}/vlen.rst (100%) diff --git a/docs/checksum32.rst b/docs/checksum32.rst index 5b2013f8..6f255141 100644 --- 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 b/docs/compression/blosc.rst similarity index 100% rename from docs/blosc.rst rename to docs/compression/blosc.rst diff --git a/docs/bz2.rst b/docs/compression/bz2.rst similarity index 100% rename from docs/bz2.rst rename to docs/compression/bz2.rst diff --git a/docs/gzip.rst b/docs/compression/gzip.rst similarity index 100% rename from docs/gzip.rst rename to docs/compression/gzip.rst diff --git a/docs/compression/index.rst b/docs/compression/index.rst new file mode 100644 index 00000000..36dc301b --- /dev/null +++ b/docs/compression/index.rst @@ -0,0 +1,14 @@ +Compression codecs +------------------ + +.. toctree:: + :maxdepth: 2 + + blosc + lz4 + zfpy + zstd + zlib + gzip + bz2 + lzma diff --git a/docs/lz4.rst b/docs/compression/lz4.rst similarity index 100% rename from docs/lz4.rst rename to docs/compression/lz4.rst diff --git a/docs/lzma.rst b/docs/compression/lzma.rst similarity index 100% rename from docs/lzma.rst rename to docs/compression/lzma.rst diff --git a/docs/zfpy.rst b/docs/compression/zfpy.rst similarity index 100% rename from docs/zfpy.rst rename to docs/compression/zfpy.rst diff --git a/docs/zlib.rst b/docs/compression/zlib.rst similarity index 100% rename from docs/zlib.rst rename to docs/compression/zlib.rst diff --git a/docs/zstd.rst b/docs/compression/zstd.rst similarity index 100% rename from docs/zstd.rst rename to docs/compression/zstd.rst diff --git a/docs/astype.rst b/docs/filter/astype.rst similarity index 100% rename from docs/astype.rst rename to docs/filter/astype.rst diff --git a/docs/bitround.rst b/docs/filter/bitround.rst similarity index 100% rename from docs/bitround.rst rename to docs/filter/bitround.rst diff --git a/docs/categorize.rst b/docs/filter/categorize.rst similarity index 100% rename from docs/categorize.rst rename to docs/filter/categorize.rst diff --git a/docs/delta.rst b/docs/filter/delta.rst similarity index 100% rename from docs/delta.rst rename to docs/filter/delta.rst diff --git a/docs/fixedscaleoffset.rst b/docs/filter/fixedscaleoffset.rst similarity index 100% rename from docs/fixedscaleoffset.rst rename to docs/filter/fixedscaleoffset.rst diff --git a/docs/filter/index.rst b/docs/filter/index.rst new file mode 100644 index 00000000..c6bfa4db --- /dev/null +++ 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 b/docs/filter/packbits.rst similarity index 100% rename from docs/packbits.rst rename to docs/filter/packbits.rst diff --git a/docs/quantize.rst b/docs/filter/quantize.rst similarity index 100% rename from docs/quantize.rst rename to docs/filter/quantize.rst diff --git a/docs/shuffle.rst b/docs/filter/shuffle.rst similarity index 100% rename from docs/shuffle.rst rename to docs/filter/shuffle.rst diff --git a/docs/index.rst b/docs/index.rst index 86a185f1..a9a0e351 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -64,29 +64,12 @@ Contents .. toctree:: :maxdepth: 2 + compression/index + filter/index + other/index + checksum32 abc registry - blosc - lz4 - zfpy - zstd - zlib - gzip - bz2 - lzma - delta - fixedscaleoffset - quantize - bitround - packbits - categorize - checksum32 - astype - json - pickles - msgpacks - vlen - shuffle release contributing diff --git a/docs/other/index.rst b/docs/other/index.rst new file mode 100644 index 00000000..0ebcbdcb --- /dev/null +++ b/docs/other/index.rst @@ -0,0 +1,11 @@ +Other codecs +------------ + + +.. toctree:: + :maxdepth: 2 + + json + pickles + msgpacks + vlen diff --git a/docs/json.rst b/docs/other/json.rst similarity index 100% rename from docs/json.rst rename to docs/other/json.rst diff --git a/docs/msgpacks.rst b/docs/other/msgpacks.rst similarity index 100% rename from docs/msgpacks.rst rename to docs/other/msgpacks.rst diff --git a/docs/pickles.rst b/docs/other/pickles.rst similarity index 100% rename from docs/pickles.rst rename to docs/other/pickles.rst diff --git a/docs/vlen.rst b/docs/other/vlen.rst similarity index 100% rename from docs/vlen.rst rename to docs/other/vlen.rst From a3e4134d30ff0f0be0e9624c422545e04d020970 Mon Sep 17 00:00:00 2001 From: David Stansby Date: Tue, 7 May 2024 13:34:35 +0100 Subject: [PATCH 2/5] Improve contents structure --- docs/api.rst | 11 +++++++++++ docs/index.rst | 6 +----- 2 files changed, 12 insertions(+), 5 deletions(-) create mode 100644 docs/api.rst diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 00000000..ae27cafe --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,11 @@ +API reference +============= + +.. toctree:: + :maxdepth: 2 + + compression/index + filter/index + other/index + checksum32 + abc diff --git a/docs/index.rst b/docs/index.rst index a9a0e351..d2a33bec 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -64,11 +64,7 @@ Contents .. toctree:: :maxdepth: 2 - compression/index - filter/index - other/index - checksum32 - abc + api registry release contributing From 6126e2c8e6a322bb4bf2854718119d90b360f6d5 Mon Sep 17 00:00:00 2001 From: David Stansby Date: Tue, 7 May 2024 13:35:25 +0100 Subject: [PATCH 3/5] Put registry in API --- docs/api.rst | 1 + docs/index.rst | 1 - 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api.rst b/docs/api.rst index ae27cafe..ef42fced 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -9,3 +9,4 @@ API reference other/index checksum32 abc + registry diff --git a/docs/index.rst b/docs/index.rst index d2a33bec..cce02f0c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -65,7 +65,6 @@ Contents :maxdepth: 2 api - registry release contributing From 5e659e2824c702d6fc3c345c091832d3c328c499 Mon Sep 17 00:00:00 2001 From: David Stansby Date: Tue, 7 May 2024 13:38:08 +0100 Subject: [PATCH 4/5] Add release note --- docs/release.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/release.rst b/docs/release.rst index 1c4f2787..a60c6d1e 100644 --- a/docs/release.rst +++ b/docs/release.rst @@ -18,13 +18,15 @@ Enhancements By :user:`Ryan Abernathey `. * Use PyData theme for docs By :user:`John Kirkham `, :issue:`485`. +* Improve the structure of docs + By :user:`David Stansby `, :issue:`458`. Fix ~~~ * Fix skip of entry points backport tests By :user:`Elliott Sales de Andrade `, :issue:`487`. -* Fix Upgrade to Zstd 1.5.5 due to potential corruption. +* Fix Upgrade to Zstd 1.5.5 due to potential corruption. By :user:`Mark Kittisopikul `, :issue:`429` Maintenance From 57196ab88361f17e0a69c258163df0a83f3b8ccb Mon Sep 17 00:00:00 2001 From: David Stansby Date: Tue, 7 May 2024 13:38:15 +0100 Subject: [PATCH 5/5] Move pcodec --- docs/compression/index.rst | 9 +++++---- docs/{ => compression}/pcodec.rst | 0 2 files changed, 5 insertions(+), 4 deletions(-) rename docs/{ => compression}/pcodec.rst (100%) diff --git a/docs/compression/index.rst b/docs/compression/index.rst index 36dc301b..ba8434d2 100644 --- a/docs/compression/index.rst +++ b/docs/compression/index.rst @@ -5,10 +5,11 @@ Compression codecs :maxdepth: 2 blosc + bz2 + gzip + lzma lz4 + pcodec zfpy - zstd zlib - gzip - bz2 - lzma + zstd diff --git a/docs/pcodec.rst b/docs/compression/pcodec.rst similarity index 100% rename from docs/pcodec.rst rename to docs/compression/pcodec.rst