From a791e31de082d2624d1ac378511e2fd236938b9b Mon Sep 17 00:00:00 2001 From: Joseph Hamman Date: Sun, 29 Dec 2024 15:12:47 -0700 Subject: [PATCH 1/4] docs: add new top level about page --- docs/about.rst | 22 ++++++++++++++++++++++ docs/index.rst | 1 + 2 files changed, 23 insertions(+) create mode 100644 docs/about.rst diff --git a/docs/about.rst b/docs/about.rst new file mode 100644 index 0000000000..e570754304 --- /dev/null +++ b/docs/about.rst @@ -0,0 +1,22 @@ +About +===== + +Zarr is a format for the storage of chunked, compressed, N-dimensional arrays +inspired by `HDF5 `_, `h5py +`_ and `bcolz `_. + +These documents describe the Zarr Python implementation. More information +about the Zarr format can be found on the `main website `_. + +If you are using Zarr, we would `love to hear about it +`_. + +Funding +------- +The project is fiscally sponsored by `NumFOCUS `_, a US +501(c)(3) public charity, and development is supported by the +`MRC Centre for Genomics and Global Health `_ +and the `Chan Zuckerberg Initiative `_. + + +.. _NumCodecs: https://numcodecs.readthedocs.io/ diff --git a/docs/index.rst b/docs/index.rst index 05e326ed69..d5cc8a603d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,6 +9,7 @@ Zarr-Python :hidden: getting_started + about user-guide/index api/index release From f34bbfdcaeaea4b1c73fd797ef23c09f1508a043 Mon Sep 17 00:00:00 2001 From: Joseph Hamman Date: Wed, 1 Jan 2025 14:46:24 -0800 Subject: [PATCH 2/4] fixup --- docs/getting_started.rst | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 77d45325e4..6d245e9264 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -1,18 +1,6 @@ Getting Started =============== -Zarr is a format for the storage of chunked, compressed, N-dimensional arrays -inspired by `HDF5 `_, `h5py -`_ and `bcolz `_. - -The project is fiscally sponsored by `NumFOCUS `_, a US -501(c)(3) public charity, and development is supported by the -`MRC Centre for Genomics and Global Health `_ -and the `Chan Zuckerberg Initiative `_. - -These documents describe the Zarr Python implementation. More information -about the Zarr format can be found on the `main website `_. - Highlights ---------- From 5afd9b3e1ebb3411798f145e0bd884db7fa4eff8 Mon Sep 17 00:00:00 2001 From: Joseph Hamman Date: Wed, 1 Jan 2025 14:48:23 -0800 Subject: [PATCH 3/4] fixup --- docs/about.rst | 6 ++++-- docs/getting_started.rst | 6 ------ 2 files changed, 4 insertions(+), 8 deletions(-) diff --git a/docs/about.rst b/docs/about.rst index e570754304..5fe79edb70 100644 --- a/docs/about.rst +++ b/docs/about.rst @@ -8,7 +8,10 @@ inspired by `HDF5 `_, `h5py These documents describe the Zarr Python implementation. More information about the Zarr format can be found on the `main website `_. -If you are using Zarr, we would `love to hear about it +Projects using Zarr +------------------- + +If you are using Zarr-Python, we would `love to hear about it `_. Funding @@ -18,5 +21,4 @@ The project is fiscally sponsored by `NumFOCUS `_, a US `MRC Centre for Genomics and Global Health `_ and the `Chan Zuckerberg Initiative `_. - .. _NumCodecs: https://numcodecs.readthedocs.io/ diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 6d245e9264..5950e2ae44 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -19,12 +19,6 @@ Feedback and bug reports are very welcome, please get in touch via the `GitHub issue tracker `_. See :doc:`contributing` for further information about contributing to Zarr. -Projects using Zarr -------------------- - -If you are using Zarr, we would `love to hear about it -`_. - .. toctree:: :caption: Getting Started :hidden: From 881de116353ac27e9c4ff23a20232f5331377197 Mon Sep 17 00:00:00 2001 From: Joseph Hamman Date: Wed, 1 Jan 2025 14:49:05 -0800 Subject: [PATCH 4/4] fixup --- docs/about.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/about.rst b/docs/about.rst index 5fe79edb70..7a0af998c0 100644 --- a/docs/about.rst +++ b/docs/about.rst @@ -5,7 +5,7 @@ Zarr is a format for the storage of chunked, compressed, N-dimensional arrays inspired by `HDF5 `_, `h5py `_ and `bcolz `_. -These documents describe the Zarr Python implementation. More information +These documents describe the Zarr-Python implementation. More information about the Zarr format can be found on the `main website `_. Projects using Zarr