Merge branch 'v3' into hypothesis-tests

* v3: (22 commits) [v3] `Buffer` ensure correct subclass based on the `BufferPrototype` argument (zarr-developers#1974) Fix doc build (zarr-developers#1987) Fix doc build warnings (zarr-developers#1985) Automatically generate API reference docs (zarr-developers#1918) Update `RemoteStore.__str__` and add UPath tests (zarr-developers#1964) [v3] Elevate codec pipeline (zarr-developers#1932) 0 dim arrays: indexing (zarr-developers#1980) `parse_shapelike` allows 0 (zarr-developers#1979) Clean up typing and docs for indexing (zarr-developers#1961) add json indentation to config (zarr-developers#1952) chore: update pre-commit hooks (zarr-developers#1973) Bump pypa/gh-action-pypi-publish in the actions group (zarr-developers#1969) chore: update pre-commit hooks (zarr-developers#1957) Update release.rst (zarr-developers#1960) doc: update release notes for 3.0.0.alpha (zarr-developers#1959) Basic working FsspecStore (zarr-developers#1785) Feature: Top level V3 API (zarr-developers#1884) Buffer Prototype Argument (zarr-developers#1910) Create issue-metrics.yml fixes bug in transpose (zarr-developers#1949) ...
dcherian · Jun 25, 2024 · 3a560ed · 3a560ed
2 parents 14cc22d + c677da4
commit 3a560ed
Show file tree

Hide file tree

Showing 68 changed files with 4,864 additions and 989 deletions.
diff --git a/.github/workflows/issue-metrics.yml b/.github/workflows/issue-metrics.yml
@@ -0,0 +1,42 @@
+name: Monthly issue metrics
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '3 2 1 * *'
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: issue metrics
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: read
+    steps:
+    - name: Get dates for last month
+      shell: bash
+      run: |
+        # Calculate the first day of the previous month
+        first_day=$(date -d "last month" +%Y-%m-01)
+
+        # Calculate the last day of the previous month
+        last_day=$(date -d "$first_day +1 month -1 day" +%Y-%m-%d)
+
+        #Set an environment variable with the date range
+        echo "$first_day..$last_day"
+        echo "last_month=$first_day..$last_day" >> "$GITHUB_ENV"
+
+    - name: Run issue-metrics tool
+      uses: github/issue-metrics@v3
+      env:
+        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        SEARCH_QUERY: 'repo:zarr-developers/zarr-python is:issue created:${{ env.last_month }} -reason:"not planned"'
+
+    - name: Create issue
+      uses: peter-evans/create-issue-from-file@v5
+      with:
+        title: Monthly issue metrics report
+        token: ${{ secrets.GITHUB_TOKEN }}
+        content-filepath: ./issue_metrics.md
diff --git a/.github/workflows/releases.yml b/.github/workflows/releases.yml
@@ -55,7 +55,7 @@ jobs:
         with:
           name: releases
           path: dist
-      - uses: pypa/gh-action-pypi-publish@v1.8.14
+      - uses: pypa/gh-action-pypi-publish@v1.9.0
         with:
           user: __token__
           password: ${{ secrets.pypi_password }}

diff --git a/.gitignore b/.gitignore
@@ -51,7 +51,6 @@ coverage.xml
 
 # Sphinx documentation
 docs/_build/
-docs/_autoapi/
 
 # PyBuilder
 target/

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -7,7 +7,7 @@ default_language_version:
   python: python3
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: 'v0.4.5'
+    rev: 'v0.4.9'
     hooks:
     - id: ruff
       args: ["--fix", "--show-fixes"]

diff --git a/docs/api.rst b/docs/api.rst
diff --git a/docs/api/attrs.rst b/docs/api/attrs.rst
diff --git a/docs/api/codecs.rst b/docs/api/codecs.rst
diff --git a/docs/api/convenience.rst b/docs/api/convenience.rst
diff --git a/docs/api/core.rst b/docs/api/core.rst
diff --git a/docs/api/creation.rst b/docs/api/creation.rst
diff --git a/docs/api/hierarchy.rst b/docs/api/hierarchy.rst
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -0,0 +1,7 @@
+API Reference
+=============
+
+.. toctree::
+    :maxdepth: 1
+
+    zarr
diff --git a/docs/api/n5.rst b/docs/api/n5.rst
diff --git a/docs/api/storage.rst b/docs/api/storage.rst
diff --git a/docs/api/sync.rst b/docs/api/sync.rst
diff --git a/docs/api/zarr.rst b/docs/api/zarr.rst
@@ -0,0 +1,5 @@
+zarr
+====
+
+.. autoapimodule:: zarr
+    :members:
diff --git a/docs/conf.py b/docs/conf.py
@@ -15,13 +15,17 @@
 
 import os
 import sys
+from typing import Any
+
+import sphinx.application
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
 import zarr
+import sphinx
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -42,19 +46,21 @@
     "sphinx.ext.autosummary",
     "sphinx.ext.viewcode",
     "sphinx.ext.intersphinx",
-    "sphinx_automodapi.automodapi",
+    'autoapi.extension',
     "numpydoc",
     "sphinx_issues",
     "sphinx_copybutton",
     "sphinx_design",
 ]
 
-numpydoc_show_class_members = False
-numpydoc_class_members_toctree = False
 issues_github_path = "zarr-developers/zarr-python"
 
-automodapi_inheritance_diagram = False
-automodapi_toctreedirnm = "_autoapi"
+autoapi_dirs = ['../src/zarr']
+autoapi_add_toctree_entry = False
+autoapi_generate_api_docs = False
+autoapi_member_order = "groupwise"
+autoapi_root = "api"
+
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -166,8 +172,7 @@
 html_logo = "_static/logo1.png"
 
 
-# Add custom css
-def setup(app):
+def setup(app: sphinx.application.Sphinx) -> None:
     app.add_css_file("custom.css")
 
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -10,7 +10,7 @@ Zarr-Python
 
     getting_started
     tutorial
-    api
+    api/index
     spec
     release
     license
@@ -80,7 +80,7 @@ Zarr is a file storage format for chunked, compressed, N-dimensional arrays base
 
         +++
 
-        .. button-ref:: api
+        .. button-ref:: api/index
             :expand:
             :color: dark
             :click-parent: