Automatically document Array members (zarr-developers#1547)

dstansby · web-flow · commit 74764af32d87 · 2023-11-24T17:31:31.000+01:00
* Automatically document Array members

* Fix Array link
diff --git a/.gitignore b/.gitignore
@@ -51,6 +51,7 @@ coverage.xml
 
 # Sphinx documentation
 docs/_build/
+docs/_autoapi/
 
 # PyBuilder
 target/
diff --git a/docs/api/core.rst b/docs/api/core.rst
@@ -1,24 +1,5 @@
 The Array class (``zarr.core``)
 ===============================
-.. module:: zarr.core
 
-.. autoclass:: Array
-
-    .. automethod:: __getitem__
-    .. automethod:: __setitem__
-    .. automethod:: get_basic_selection
-    .. automethod:: set_basic_selection
-    .. automethod:: get_mask_selection
-    .. automethod:: set_mask_selection
-    .. automethod:: get_block_selection
-    .. automethod:: set_block_selection
-    .. automethod:: get_coordinate_selection
-    .. automethod:: set_coordinate_selection
-    .. automethod:: get_orthogonal_selection
-    .. automethod:: set_orthogonal_selection
-    .. automethod:: digest
-    .. automethod:: hexdigest
-    .. automethod:: resize
-    .. automethod:: append
-    .. automethod:: view
-    .. automethod:: astype
+.. automodapi:: zarr.core
+   :no-heading:
diff --git a/docs/conf.py b/docs/conf.py
@@ -42,6 +42,7 @@
     "sphinx.ext.autosummary",
     "sphinx.ext.viewcode",
     "sphinx.ext.intersphinx",
+    "sphinx_automodapi.automodapi",
     "numpydoc",
     "sphinx_issues",
     "sphinx_copybutton",
@@ -52,6 +53,9 @@
 numpydoc_class_members_toctree = False
 issues_github_path = "zarr-developers/zarr-python"
 
+automodapi_inheritance_diagram = False
+automodapi_toctreedirnm = "_autoapi"
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -45,6 +45,7 @@ jupyter = [
 ]
 docs = [
     'sphinx',
+    'sphinx-automodapi',
     'sphinx_design',
     'sphinx-issues',
     'sphinx-copybutton',
diff --git a/zarr/core.py b/zarr/core.py
@@ -60,6 +60,8 @@
     ensure_ndarray_like,
 )
 
+__all__ = ["Array"]
+
 
 # noinspection PyUnresolvedReferences
 class Array:
@@ -110,62 +112,6 @@ class Array:
         to users. Use `numpy.empty(())` by default.
 
         .. versionadded:: 2.13
-
-
-    Attributes
-    ----------
-    store
-    path
-    name
-    read_only
-    chunk_store
-    shape
-    chunks
-    dtype
-    compression
-    compression_opts
-    dimension_separator
-    fill_value
-    order
-    synchronizer
-    filters
-    attrs
-    size
-    itemsize
-    nbytes
-    nbytes_stored
-    cdata_shape
-    nchunks
-    nchunks_initialized
-    is_view
-    info
-    vindex
-    oindex
-    blocks
-    write_empty_chunks
-    meta_array
-
-    Methods
-    -------
-    __getitem__
-    __setitem__
-    get_basic_selection
-    set_basic_selection
-    get_orthogonal_selection
-    set_orthogonal_selection
-    get_mask_selection
-    set_mask_selection
-    get_coordinate_selection
-    set_coordinate_selection
-    get_block_selection
-    set_block_selection
-    digest
-    hexdigest
-    resize
-    append
-    view
-    astype
-
     """
 
     def __init__(

Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,7 @@ jupyter = [`
`45`	`45`	`]`
`46`	`46`	`docs = [`
`47`	`47`	`'sphinx',`
	`48`	`+ 'sphinx-automodapi',`
`48`	`49`	`'sphinx_design',`
`49`	`50`	`'sphinx-issues',`
`50`	`51`	`'sphinx-copybutton',`