Refactor test utils to use a class

docs/conf.py

@@ -32,12 +32,17 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
     "scanpydoc.elegant_typehints",
+    "sphinx_autofixture",
 ]
 
 #  API documentation when building
 nitpicky = True
 autosummary_generate = True
 autodoc_member_order = "bysource"
+autodoc_default_options = {
+    "special-members": "__call__",  # `True` adds too much stuff to dataclasses
+    "inherited-members": False,
+}
 napoleon_google_docstring = False
 napoleon_numpy_docstring = True
 todo_include_todos = False
@@ -55,9 +60,11 @@
     "np.dtype": "numpy.dtype",
     "np.number": "numpy.number",
     "np.integer": "numpy.integer",
+    "np.random.Generator": "numpy.random.Generator",
     "ArrayLike": "numpy.typing.ArrayLike",
     "DTypeLike": "numpy.typing.DTypeLike",
     "NDArray": "numpy.typing.NDArray",
+    "_pytest.fixtures.FixtureRequest": "pytest.FixtureRequest",
     **{
         k: v
         for k_plain, v in {
@@ -74,10 +81,14 @@
 # If that doesn’t work, ignore them
 nitpick_ignore = {
     ("py:class", "fast_array_utils.types.T_co"),
+    ("py:class", "_DTypeLikeFloat32"),
+    ("py:class", "_DTypeLikeFloat64"),
     # sphinx bugs, should be covered by `autodoc_type_aliases` above
+    ("py:class", "Array"),
     ("py:class", "ArrayLike"),
     ("py:class", "DTypeLike"),
     ("py:class", "NDArray"),
+    ("py:class", "_pytest.fixtures.FixtureRequest"),
 }
 
 # Options for HTML output

docs/index.rst

@@ -1,10 +1,15 @@
 ``fast_array_utils``
 ====================
 
+.. toctree::
+   :hidden:
+
+   fast-array-utils <self>
+   testing
+
 .. automodule:: fast_array_utils
    :members:
 
-
 ``fast_array_utils.conv``
 -------------------------
 

docs/testing.rst

@@ -0,0 +1,11 @@
+``testing.fast_array_utils``
+============================
+
+.. automodule:: testing.fast_array_utils
+   :members:
+
+``testing.fast_array_utils.pytest``
+-----------------------------------
+
+.. automodule:: testing.fast_array_utils.pytest
+   :members:

pyproject.toml

@@ -23,7 +23,14 @@ classifiers = [
 ]
 dynamic = [ "description", "version" ]
 dependencies = [ "numba", "numpy" ]
-optional-dependencies.doc = [ "furo", "scanpydoc>=0.15.2", "sphinx>=8", "sphinx-autodoc-typehints" ]
+optional-dependencies.doc = [
+  "furo",
+  "pytest",
+  "scanpydoc>=0.15.2",
+  "sphinx>=8",
+  "sphinx-autodoc-typehints",
+  "sphinx-autofixture",
+]
 optional-dependencies.full = [ "dask", "fast-array-utils[sparse]", "h5py", "zarr" ]
 optional-dependencies.sparse = [ "scipy>=1.8" ]
 optional-dependencies.test = [ "coverage[toml]", "pytest", "pytest-codspeed" ]