Skip to content

docs: convert notebooks to jupytext scripts - #610

Open
jo-mueller wants to merge 6 commits into
ome:masterfrom
jo-mueller:jupytext
Open

docs: convert notebooks to jupytext scripts#610
jo-mueller wants to merge 6 commits into
ome:masterfrom
jo-mueller:jupytext

Conversation

@jo-mueller

@jo-mueller jo-mueller commented Aug 1, 2026

Copy link
Copy Markdown
Collaborator

Fixes #604

Rebased on #609

d-v-b and others added 4 commits July 31, 2026 16:57
zarr 3.3.0 changed codec configuration attributes such as
`BloscCodec.cname` and `BytesCodec.endian` from `Enum` members to plain
strings, breaking the `.name` accesses in the label writer storage
options tests (12 failures).

Add a `_codec_value` helper that normalizes both representations, so the
tests pass against zarr 3.2 and 3.3 alike. Test-only change; the library
code never accessed these attributes.

Assisted-by: ClaudeCode:claude-opus-5
@codecov

codecov Bot commented Aug 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.89%. Comparing base (e65666e) to head (3292bb7).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #610      +/-   ##
==========================================
+ Coverage   86.46%   86.89%   +0.42%     
==========================================
  Files          16       16              
  Lines        2365     2365              
==========================================
+ Hits         2045     2055      +10     
+ Misses        320      310      -10     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@jo-mueller jo-mueller changed the title WIP: docs: convert notebooks to jupytext scripts docs: convert notebooks to jupytext scripts Aug 1, 2026
@jo-mueller

Copy link
Copy Markdown
Collaborator Author

@jni is that roughly how it is done over at napari? In VSCode, it's relatively easy to spawn these scripts from jupyter notebooks. It's probably equally easy to turn them into markdown files with executable python code blocks.

@jo-mueller
jo-mueller marked this pull request as ready for review August 1, 2026 20:19
@jni

jni commented Aug 2, 2026

Copy link
Copy Markdown
Contributor

is that roughly how it is done over at napari?

Yes! Jupytext allows many formats, .py with comments is one, md with python blocks is another. It's a matter of preference which one is preferred, and I guess it depends on the balance of narrative vs code.

You're probably missing a whole bunch of dependencies to get napari windows to spawn, I think this is the most important one:

https://github.com/napari/shared-workflows/blob/200f011f642fd89598422aa14d361113a9bd8059/.github/workflows/build_docs.yml#L76-L80

@jni

jni commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Seems to be working fine!

It will be nice in follow-up PRs to add visualisation with napari, but I think it's best to do that later since this build is working. I spot-checked a couple of pages to make sure that the output was the same.

@jo-mueller

Copy link
Copy Markdown
Collaborator Author

It will be nice in follow-up PRs to add visualisation with napari, but I think it's best to do that later since this build is working.

Agree! Depending on who shows up later today on the napari-ome-zarr-py call, I'll probably merge it later today 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs build: use jupytext/mystmd to allow markdown as source instead of ipynb

3 participants