redirect parameter types

theislab · Oct 10, 2024 · e7add5e · e7add5e
1 parent 8bfa618
commit e7add5e
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -67,6 +67,8 @@
     "sphinx.ext.mathjax",
     "IPython.sphinxext.ipython_console_highlighting",
     "sphinxext.opengraph",
+    "scanpydoc.elegant_typehints",
+    "scanpydoc.definition_list_typed_field",
     *[p.stem for p in (HERE / "extensions").glob("*.py")],
 ]
 
@@ -140,10 +142,14 @@
 nitpick_ignore = [
     # https://github.com/duckdb/duckdb-web/issues/3806
     ("py:class", "duckdb.duckdb.DuckDBPyConnection"),
-    # zarr doesn’t document its base Store class
-    ("py:class", "zarr._storage.store.Store"),
 ]
 
+# Redirect broken parameter annotation classes
+qualname_overrides = {
+    "zarr._storage.store.Store": "zarr.storage.MemoryStore",
+    "lnschema_core.models.Artifact": "lamindb.Artifact",
+}
+
 
 def setup(app: Sphinx) -> None:
     """Setup lamindb for CI."""

diff --git a/pyproject.toml b/pyproject.toml
@@ -41,6 +41,7 @@ optional-dependencies.doc = [
   "ipython",
   "myst-nb>=1.1",
   "pandas",
+  "scanpydoc",
   # Until pybtex >0.23.0 releases: https://bitbucket.org/pybtex-devs/pybtex/issues/169/
   "setuptools",
   "sphinx>=4",