Skip to content

Commit 03dd2ef

Browse files
committed
Remove specs pages from docs
1 parent 01b73a7 commit 03dd2ef

File tree

8 files changed

+20
-44
lines changed

8 files changed

+20
-44
lines changed

docs/contributing.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,8 @@ Data format compatibility
307307
The data format used by Zarr is defined by a specification document, which should be
308308
platform-independent and contain sufficient detail to construct an interoperable
309309
software library to read and/or write Zarr data using any programming language. The
310-
latest version of the specification document is available from the :ref:`spec` page.
310+
latest version of the specification document is available on the
311+
`Zarr specifications website<https://zarr-specs.readthedocs.io>`_.
311312

312313
Here, **data format compatibility** means that all software libraries that implement a
313314
particular version of the Zarr storage specification are interoperable, in the sense

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ Zarr-Python
1212
tutorial
1313
guide/index
1414
api/index
15-
spec
1615
release
1716
license
1817
contributing
@@ -27,6 +26,7 @@ Zarr-Python
2726
`Source Repository <https://github.com/zarr-developers/zarr-python>`_ |
2827
`Issue Tracker <https://github.com/zarr-developers/zarr-python/issues>`_ |
2928
`Zulip Chat <https://ossci.zulipchat.com/>`_
29+
`Zarr specifications <https://zarr-specs.readthedocs.io>`_
3030

3131
Zarr is a file storage format for chunked, compressed, N-dimensional arrays based on an open-source specification.
3232

docs/release.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -216,17 +216,17 @@ Typing
216216
Maintenance
217217
~~~~~~~~~~~
218218

219-
* Remedy a situation where ``zarr-python`` was importing ``DummyStorageTransformer`` from the test suite.
219+
* Remedy a situation where ``zarr-python`` was importing ``DummyStorageTransformer`` from the test suite.
220220
The dependency relationship is now reversed: the test suite imports this class from ``zarr-python``.
221221
By :user:`Davis Bennett <d-v-b>` :issue:`1601`.
222222

223-
* [V3] Update minimum supported Python and Numpy versions.
223+
* [V3] Update minimum supported Python and Numpy versions.
224224
By :user:`Joe Hamman <jhamman>` :issue:`1638`
225225

226226
* use src layout and use hatch for packaging.
227227
By :user:`Davis Bennett <d-v-b>` :issue:`1592`.
228228

229-
* temporarily disable mypy in v3 directory.
229+
* temporarily disable mypy in v3 directory.
230230
By :user:`Joe Hamman <jhamman>` :issue:`1649`.
231231

232232
* create hatch test env.
@@ -313,10 +313,10 @@ Maintenance
313313
Documentation
314314
~~~~~~~~~~~~~
315315

316-
* Specify docs hatch env for v3 branch.
316+
* Specify docs hatch env for v3 branch.
317317
By :user:`Max Jones <maxrjones>` :issue:`1655`.
318318

319-
* Development installation/contributing docs updates.
319+
* Development installation/contributing docs updates.
320320
By :user:`Alden Keefe Sampson <aldenks>` :issue:`1643`.
321321

322322
* chore: update project settings per scientific python repo-review.
@@ -334,7 +334,7 @@ Enhancements
334334
~~~~~~~~~~~~
335335
* Added support for creating a copy of data when converting a `zarr.Array`
336336
to a numpy array.
337-
By :user:`David Stansby <dstansby>` (:issue:`2106`) and
337+
By :user:`David Stansby <dstansby>` (:issue:`2106`) and
338338
:user:`Joe Hamman <jhamman>` (:issue:`2123`).
339339

340340
Maintenance
@@ -2189,7 +2189,7 @@ Other changes
21892189
~~~~~~~~~~~~~
21902190

21912191
To accommodate support for hierarchies and filters, the Zarr metadata format
2192-
has been modified. See the :ref:`spec_v2` for more information. To migrate an
2192+
has been modified. See the ``spec_v2`` for more information. To migrate an
21932193
array stored using Zarr version 1.x, use the :func:`zarr.storage.migrate_1to2`
21942194
function.
21952195

@@ -2235,14 +2235,14 @@ abstraction layer between the core array logic and data storage (:issue:`21`).
22352235
In this release, any
22362236
object that implements the ``MutableMapping`` interface can be used as
22372237
an array store. See the tutorial sections on :ref:`tutorial_persist`
2238-
and :ref:`tutorial_storage`, the :ref:`spec_v1`, and the
2238+
and :ref:`tutorial_storage`, the ``spec_v1``, and the
22392239
:mod:`zarr.storage` module documentation for more information.
22402240

22412241
Please note also that the file organization and file name conventions
22422242
used when storing a Zarr array in a directory on the file system have
22432243
changed. Persistent Zarr arrays created using previous versions of the
22442244
software will not be compatible with this version. See the
2245-
:mod:`zarr.storage` API docs and the :ref:`spec_v1` for more
2245+
:mod:`zarr.storage` API docs and the ``spec_v1`` for more
22462246
information.
22472247

22482248
Compression
@@ -2255,7 +2255,7 @@ as the default compressor, however other compressors including zlib,
22552255
BZ2 and LZMA are also now supported via the Python standard
22562256
library. New compressors can also be dynamically registered for use
22572257
with Zarr. See the tutorial sections on :ref:`tutorial_compress` and
2258-
:ref:`tutorial_tips_blosc`, the :ref:`spec_v1`, and the
2258+
:ref:`tutorial_tips_blosc`, the ``spec_v1``, and the
22592259
:mod:`zarr.compressors` module documentation for more information.
22602260

22612261
Synchronization

docs/spec.rst

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

docs/spec/v1.rst

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

docs/spec/v2.rst

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

docs/spec/v3.rst

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

test.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import zarr
2+
3+
store = zarr.DirectoryStore("data")
4+
r = zarr.open_group(store=store)
5+
z = r.full("myArray", 42, shape=(), dtype="i4", compressor=None)
6+
7+
print(z.oindex[...])

0 commit comments

Comments
 (0)