Skip to content

Commit 65e7ac7

Browse files
committed
fix docs after codecs merge
1 parent 80dc7f4 commit 65e7ac7

File tree

4 files changed

+21
-31
lines changed

4 files changed

+21
-31
lines changed

docs/api.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,5 @@ API reference
88
api/core
99
api/hierarchy
1010
api/storage
11-
api/compressors
12-
api/filters
11+
api/codecs
1312
api/sync

docs/api/codecs.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Compressors and filters (``zarr.codecs``)
2+
=========================================
3+
.. module:: zarr.codecs
4+
5+
This module contains compressor and filter classes for use with Zarr.
6+
7+
Other codecs can be registered dynamically with Zarr. All that is required
8+
is to implement a class that provides the same interface as the classes listed
9+
below, and then to add the class to the ``codec_registry``. See the source
10+
code of this module for details.
11+
12+
.. autoclass:: BloscCompressor
13+
.. autoclass:: ZlibCompressor
14+
.. autoclass:: BZ2Compressor
15+
.. autoclass:: LZMACompressor
16+
.. autoclass:: DeltaFilter
17+
.. autoclass:: FixedScaleOffsetFilter
18+
.. autoclass:: QuantizeFilter
19+
.. autoclass:: PackBitsFilter
20+
.. autoclass:: CategorizeFilter

docs/api/compressors.rst

Lines changed: 0 additions & 20 deletions
This file was deleted.

docs/api/filters.rst

Lines changed: 0 additions & 9 deletions
This file was deleted.

0 commit comments

Comments
 (0)