Merge pull request #185 from sbesson/writer_docstrings

Convert `ome_zarr.writer.write_multiscale` to use docstrings markup

.pre-commit-config.yaml

@@ -58,8 +58,9 @@ repos:
           # default black line length is 88
           "--max-line-length=88",
           # Conflicts with black: E203 whitespace before ':'
-          "--ignore=E203",
-          "--rst-roles=class,func,ref,mod,const",
+          # Does not recognize deprecated directive in docstrings
+          "--ignore=E203,RST303",
+          "--rst-roles=class,func,ref,mod,meth,const",
         ]
 
   - repo: https://github.com/pre-commit/mirrors-mypy

docs/source/conf.py

@@ -8,6 +8,7 @@
 extensions = [
     "sphinx.ext.doctest",
     "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
 ]
 
 # use index.rst instead of contents.rst
@@ -18,3 +19,12 @@
 project = "ome-zarr-py"
 copyright = "Open Microscopy Environment"  # noqa: A001
 author = "Open Microscopy Environment"
+
+# Example configuration for intersphinx: refer to the Python standard library.
+# use in refs e.g:
+# :ref:`comparison manual <python:comparisons>`
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/", None),
+    "numpy": ("https://numpy.org/doc/stable/", None),
+    "zarr": ("https://zarr.readthedocs.io/en/stable/", None),
+}