Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove specs pages from docs #2555

Merged
merged 5 commits into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
"sphinx_issues",
"sphinx_copybutton",
"sphinx_design",
'sphinx_reredirects',
]

issues_github_path = "zarr-developers/zarr-python"
Expand Down Expand Up @@ -81,6 +82,13 @@
version = get_version("zarr")
release = get_version("zarr")

redirects = {
"spec": "https://zarr-specs.readthedocs.io",
joshmoore marked this conversation as resolved.
Show resolved Hide resolved
"spec/v1": 'https://zarr-specs.readthedocs.io/en/latest/v1/v1.0.html',
"spec/v2": "https://zarr-specs.readthedocs.io/en/latest/v2/v2.0.html",
"spec/v3": "https://zarr-specs.readthedocs.io/en/latest/v3/core/v3.0.html",
}

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
Expand Down
3 changes: 2 additions & 1 deletion docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,8 @@ Data format compatibility
The data format used by Zarr is defined by a specification document, which should be
platform-independent and contain sufficient detail to construct an interoperable
software library to read and/or write Zarr data using any programming language. The
latest version of the specification document is available from the :ref:`spec` page.
latest version of the specification document is available on the
`Zarr specifications website <https://zarr-specs.readthedocs.io>`_.

Here, **data format compatibility** means that all software libraries that implement a
particular version of the Zarr storage specification are interoperable, in the sense
Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ Zarr-Python
tutorial
guide/index
api/index
spec
release
license
contributing
Expand All @@ -26,7 +25,8 @@ Zarr-Python
`Installation <installation.html>`_ |
`Source Repository <https://github.com/zarr-developers/zarr-python>`_ |
`Issue Tracker <https://github.com/zarr-developers/zarr-python/issues>`_ |
`Zulip Chat <https://ossci.zulipchat.com/>`_
`Zulip Chat <https://ossci.zulipchat.com/>`_ |
`Zarr specifications <https://zarr-specs.readthedocs.io>`_

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

Expand Down
20 changes: 10 additions & 10 deletions docs/release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -216,17 +216,17 @@ Typing
Maintenance
~~~~~~~~~~~

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

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

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

* temporarily disable mypy in v3 directory.
* temporarily disable mypy in v3 directory.
By :user:`Joe Hamman <jhamman>` :issue:`1649`.

* create hatch test env.
Expand Down Expand Up @@ -313,10 +313,10 @@ Maintenance
Documentation
~~~~~~~~~~~~~

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

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

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

Maintenance
Expand Down Expand Up @@ -2189,7 +2189,7 @@ Other changes
~~~~~~~~~~~~~

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

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

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

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

Synchronization
Expand Down
11 changes: 0 additions & 11 deletions docs/spec.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/spec/v1.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/spec/v2.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/spec/v3.rst

This file was deleted.

1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ docs = [
'sphinx_design',
'sphinx-issues',
'sphinx-copybutton',
'sphinx-reredirects',
'pydata-sphinx-theme',
'numpydoc',
'numcodecs[msgpack]',
Expand Down
7 changes: 7 additions & 0 deletions test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import zarr

store = zarr.DirectoryStore("data")
r = zarr.open_group(store=store)
z = r.full("myArray", 42, shape=(), dtype="i4", compressor=None)

print(z.oindex[...])
Loading