Add documentation for find/findall using visit

[caviere]

Resolves #188

[caviere]

In docs/, on running:

make clean
make html

I get the following error:

sphinx-build -b html -d _build/doctrees   . _build/html
Running Sphinx v5.3.0
making output directory... done
[autosummary] generating autosummary for: api.rst, api/attrs.rst, api/codecs.rst, api/convenience.rst, api/core.rst, api/creation.rst, api/hierarchy.rst, api/n5.rst, api/storage.rst, api/sync.rst, contributing.rst, index.rst, installation.rst, license.rst, release.rst, spec.rst, spec/v1.rst, spec/v2.rst, spec/v3.rst, tutorial.rst
loading intersphinx inventory from https://docs.python.org/objects.inv...
loading intersphinx inventory from https://numpy.org/doc/stable/objects.inv...
intersphinx inventory has moved: https://docs.python.org/objects.inv -> https://docs.python.org/3/objects.inv
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 20 source files that are out of date
updating environment: [new config] 20 added, 0 changed, 0 removed
reading sources... [100%] tutorial
/home/kinya/zarr-python/zarr/hierarchy.py:docstring of zarr.hierarchy.Group.visit:41: ERROR: Unexpected indentation.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] tutorial
generating indices... genindex py-modindex done
highlighting module code... [100%] zarr.sync
writing additional pages... search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 1 warning.

The HTML pages are in _build/html.

Build finished. The HTML pages are in _build/html.

[codecov]

Codecov Report

Merging #1241 (0b8ba76) into main (e474947) will decrease coverage by 0.00%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1241      +/-   ##
==========================================
- Coverage   99.99%   99.99%   -0.01%     
==========================================
  Files          35       33       -2     
  Lines       14135    13739     -396     
==========================================
- Hits        14134    13738     -396     
  Misses          1        1              

Impacted Files	Coverage Δ
zarr/hierarchy.py	99.78% <ø> (-0.01%)	⬇️
zarr/errors.py	100.00% <0.00%> (ø)
zarr/storage.py	100.00% <0.00%> (ø)
zarr/creation.py	100.00% <0.00%> (ø)
zarr/convenience.py	100.00% <0.00%> (ø)
zarr/__init__.py
zarr/util.py

[joshmoore]

The build is happy again, @caviere, (:+1:) but it looks like the formatting of the tree is squished:

from: https://zarr--1241.org.readthedocs.build/en/1241/

[caviere]

I forgot to check how the docs look on the browser. I have now fixed it after reading on how to add literal blocks for sphinx https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#literal-blocks

[joshmoore]

This is great, @caviere. Thanks for doing the research and getting it into the docs!