Skip to content

Commit d1a0d99

Browse files
authored
V3 reorg (#1809)
* move v2 code/tests to v2 directories * move zarr v3 code to root * add extra doc deps * import __version__ in root __init__
1 parent f7993db commit d1a0d99

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

92 files changed

+2055
-2121
lines changed

docs/api.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ API reference
1313
api/codecs
1414
api/attrs
1515
api/sync
16-
api/v3
1716

1817
Indices and tables
1918
------------------

docs/api/attrs.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
The Attributes class (``zarr.attrs``)
2-
=====================================
3-
.. module:: zarr.attrs
1+
The Attributes class (``zarr.v2.attrs``)
2+
========================================
3+
.. module:: zarr.v2.attrs
44

55
.. autoclass:: Attributes
66

docs/api/codecs.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Compressors and filters (``zarr.codecs``)
2-
=========================================
1+
Compressors and filters (``zarr.v2.codecs``)
2+
============================================
33
.. module:: zarr.codecs
44

55
This module contains compressor and filter classes for use with Zarr. Please note that this module
@@ -8,9 +8,9 @@ onwards, all codec classes have been moved to a separate package called Numcodec
88
packages (Zarr and Numcodecs_) are designed to be used together. For example, a Numcodecs_ codec
99
class can be used as a compressor for a Zarr array::
1010

11-
>>> import zarr
11+
>>> import zarr.v2
1212
>>> from numcodecs import Blosc
13-
>>> z = zarr.zeros(1000000, compressor=Blosc(cname='zstd', clevel=1, shuffle=Blosc.SHUFFLE))
13+
>>> z = zarr.v2.zeros(1000000, compressor=Blosc(cname='zstd', clevel=1, shuffle=Blosc.SHUFFLE))
1414

1515
Codec classes can also be used as filters. See the tutorial section on :ref:`tutorial_filters`
1616
for more information.

docs/api/convenience.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
Convenience functions (``zarr.convenience``)
2-
============================================
3-
.. automodule:: zarr.convenience
1+
Convenience functions (``zarr.v2.convenience``)
2+
===============================================
3+
.. automodule:: zarr.v2.convenience
44
.. autofunction:: open
55
.. autofunction:: save
66
.. autofunction:: load

docs/api/core.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
The Array class (``zarr.core``)
2-
===============================
1+
The Array class (``zarr.v2.core``)
2+
==================================
33

4-
.. automodapi:: zarr.core
4+
.. automodapi:: zarr.v2.core
55
:no-heading:

docs/api/creation.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
Array creation (``zarr.creation``)
2-
==================================
3-
.. module:: zarr.creation
1+
Array creation (``zarr.v2.creation``)
2+
=====================================
3+
.. module:: zarr.v2.creation
44
.. autofunction:: create
55
.. autofunction:: empty
66
.. autofunction:: zeros

docs/api/hierarchy.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
Groups (``zarr.hierarchy``)
2-
===========================
3-
.. module:: zarr.hierarchy
1+
Groups (``zarr.v2.hierarchy``)
2+
==============================
3+
.. module:: zarr.v2.hierarchy
44

55
.. autofunction:: group
66
.. autofunction:: open_group

docs/api/n5.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
N5 (``zarr.n5``)
2-
================
3-
.. automodule:: zarr.n5
1+
N5 (``zarr.v2.n5``)
2+
===================
3+
.. automodule:: zarr.v2.n5
44

55
.. autoclass:: N5Store

docs/api/storage.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
Storage (``zarr.storage``)
2-
==========================
3-
.. automodule:: zarr.storage
1+
Storage (``zarr.v2.storage``)
2+
=============================
3+
.. automodule:: zarr.v2.storage
44

55
.. autoclass:: MemoryStore
66
.. autoclass:: DirectoryStore

docs/api/sync.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
Synchronization (``zarr.sync``)
2-
===============================
3-
.. module:: zarr.sync
1+
Synchronization (``zarr.v2.sync``)
2+
==================================
3+
.. module:: zarr.v2.sync
44

55
.. autoclass:: ThreadSynchronizer
66
.. autoclass:: ProcessSynchronizer

0 commit comments

Comments
 (0)