zarr-developers / VirtualiZarr

Create virtual Zarr stores from archival data files using xarray syntax
https://virtualizarr.readthedocs.io/en/stable/api.html
Apache License 2.0
123 stars 24 forks source link

Warnings when building docs #299

Closed TomNicholas closed 1 week ago

TomNicholas commented 1 week ago

There are a few minor warnings when building the docs, such as

/Users/tom/Documents/Work/Code/virtualizarr/docs/faq.md:58: WARNING: 'myst' cross-reference target not found: 'how-do-virtualizarr-and-kerchunk-compare' [myst.xref_missing]
/Users/tom/Documents/Work/Code/virtualizarr/docs/index.md:67: WARNING: more than one target found for 'myst' cross-reference usage: could be :std:ref:`Usage docs page` or :std:doc:`Usage docs page` [myst.xref_ambiguous]
/Users/tom/Documents/Work/Code/virtualizarr/docs/usage.md:73: WARNING: 'myst' cross-reference target not found: 'combining-virtual-datasets' [myst.xref_missing]
/Users/tom/Documents/Work/Code/virtualizarr/docs/usage.md:73: WARNING: 'myst' cross-reference target not found: 'writing-virtual-stores-to-disk' [myst.xref_missing]

It would be good to fix these and then change the readthedocs settings to count a warning as a failure, so that no broken links creep in again.