search

zarr-developers / VirtualiZarr

Create virtual Zarr stores from archival data files using xarray syntax
https://virtualizarr.readthedocs.io/en/latest/
Apache License 2.0
100 stars 21 forks source link

Executable code examples in docs #83

Open TomNicholas opened 6 months ago

TomNicholas commented 6 months ago

The main usage docs revolve around code examples, but these are currently just hard-coded in. It would be good to generate these results automatically, and even better if the docs would display the lovely xarray HTML repr instead of the boring string repr.

I'm not sure what the best way to set that up with myst-markdown is. Do I need to rewrite the usage.md page as a jupyter notebook?

ayushnag commented 6 months ago

Yes, if you use jupyter notebook files they will show the xarray HTML output. They can also be auto executed on compilation: https://jupyterbook.org/en/stable/content/execute.html