Skip to content

Commit b6787ee

Browse files
authored
Add docstring inventories for optional dependencies (#674)
1 parent e6306a8 commit b6787ee

File tree

3 files changed

+15
-8
lines changed

3 files changed

+15
-8
lines changed

mkdocs.yml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,14 @@ plugins:
111111
- https://numcodecs.readthedocs.io/en/stable/objects.inv
112112
- https://zarr.readthedocs.io/en/stable/objects.inv
113113
- https://developmentseed.org/obstore/latest/objects.inv
114-
114+
- https://filesystem-spec.readthedocs.io/en/latest/objects.inv
115+
- https://requests.readthedocs.io/en/latest/objects.inv
116+
- https://docs.aiohttp.org/en/stable/objects.inv
117+
- https://s3fs.readthedocs.io/en/latest/objects.inv
118+
- https://docs.h5py.org/en/stable/objects.inv
119+
- https://icechunk.io/en/stable/objects.inv
120+
- https://lithops-cloud.github.io/docs/objects.inv
121+
- https://docs.dask.org/en/stable/objects.inv
115122
# https://github.com/developmentseed/titiler/blob/50934c929cca2fa8d3c408d239015f8da429c6a8/docs/mkdocs.yml#L115-L140
116123
markdown_extensions:
117124
- admonition

virtualizarr/manifests/store.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ class ManifestStore(Store):
192192
Root group of the store.
193193
Contains group metadata, [ManifestArrays][virtualizarr.manifests.ManifestArray], and any subgroups.
194194
store_registry : ObjectStoreRegistry
195-
[ObjectStoreRegistry][virtualizarr.manifests.ObjectStoreRegistry] that maps the URL scheme and netloc to [ObjectStore][obstore.store.ObjectStore]instances,
195+
[ObjectStoreRegistry][virtualizarr.manifests.ObjectStoreRegistry] that maps the URL scheme and netloc to [ObjectStore][obstore.store.ObjectStore] instances,
196196
allowing ManifestStores to read from different ObjectStore instances.
197197
198198
Warnings

virtualizarr/parallel.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ def shutdown(self, wait: bool = True, *, cancel_futures: bool = False) -> None:
126126

127127
class DaskDelayedExecutor(Executor):
128128
"""
129-
An Executor that uses dask.delayed for parallel computation.
129+
An Executor that uses [dask.delayed][dask.delayed.delayed] for parallel computation.
130130
131131
This executor mimics the concurrent.futures.Executor interface but uses Dask's delayed computation model.
132132
"""
@@ -139,7 +139,7 @@ def __init__(self) -> None:
139139

140140
def submit(self, fn: Callable[..., T], /, *args: Any, **kwargs: Any) -> Future[T]:
141141
"""
142-
Submit a task to be computed with dask.delayed.
142+
Submit a task to be computed with [dask.delayed][dask.delayed.delayed].
143143
144144
Parameters
145145
----------
@@ -185,7 +185,7 @@ def map(
185185
chunksize: int = 1,
186186
) -> Iterator[T]:
187187
"""
188-
Apply a function to an iterable using dask.delayed.
188+
Apply a function to an iterable using [dask.delayed][dask.delayed.delayed].
189189
190190
Parameters
191191
----------
@@ -226,9 +226,9 @@ def shutdown(self, wait: bool = True, *, cancel_futures: bool = False) -> None:
226226

227227
class LithopsEagerFunctionExecutor(Executor):
228228
"""
229-
Lithops-based function executor which follows the concurrent.futures.Executor API.
229+
Lithops-based function executor which follows the [concurrent.futures.Executor][] API.
230230
231-
Only required because lithops doesn't follow the concurrent.futures.Executor API, see https://github.com/lithops-cloud/lithops/issues/1427.
231+
Only required because lithops doesn't follow the [concurrent.futures.Executor][] API, see https://github.com/lithops-cloud/lithops/issues/1427.
232232
"""
233233

234234
def __init__(self, **kwargs) -> None:
@@ -294,7 +294,7 @@ def map(
294294
"""
295295
Apply a function to an iterable using lithops.
296296
297-
Only needed because lithops.FunctionExecutor.map returns futures, unlike ``concurrent.futures.Executor.map``.
297+
Only needed because [lithops.executors.FunctionExecutor.map][lithops.executors.FunctionExecutor.map] returns futures, unlike [concurrent.futures.Executor.map][].
298298
299299
Parameters
300300
----------

0 commit comments

Comments
 (0)