Skip to content

Fix mix of .rst and .md on README #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
will-moore merged 2 commits into from
Dec 2, 2025
Merged

Fix mix of .rst and .md on README #23

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e12286
Fix mix of .rst and .md
lubianat Dec 2, 2025
ab09570
Remove v0.1; format link
lubianat Dec 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ omero-web-zarr

OMERO.web plugin for OME-Zarr.

Implementation of [OME-NGFF](https://ngff.openmicroscopy.org/latest/) API with an omero-web app.
Implementation of `OME-NGFF <https://ngff.openmicroscopy.org/latest/>`_ API with an omero-web app.

This plugin supports OME-NGFF v0.1, v03, v0.4.
Copy link
Member

@will-moore will-moore Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you also remove the v0.1 here as I think that is wrong.

And in the line below, could you update it like the example URLs at the bottom.
e.g.

https://[omero-server]/zarr/v0.4/image/[ID].zarr/

Great, thanks

For a given Image ID in OMERO, the following URL will refer to an OME-NGFF image::
Expand All @@ -18,8 +18,8 @@ For a given Image ID in OMERO, the following URL will refer to an OME-NGFF image

Note: This app has not been extensively tested and should **not** be considered "production ready".

Currently supports [OME-NGFF v0.3](https://ngff.openmicroscopy.org/0.3/index.html) and
[OME-NGFF v0.4](https://ngff.openmicroscopy.org/0.4/index.html).
Currently supports `OME-NGFF v0.3 <https://ngff.openmicroscopy.org/0.3/index.html>`_ and
`OME-NGFF v0.4 <https://ngff.openmicroscopy.org/0.4/index.html>`_.

Development
-----------
Expand Down Expand Up @@ -59,7 +59,7 @@ Then you will be able to access OMERO Images in OME-NGFF format v0.3 or v0.4 wit
[omero-server]/zarr/v0.4/image/[ID].zarr/0/0/0/0


You can see this in action using the [Vizarr](https://github.com/hms-dbmi/vizarr/) viewer.
You can see this in action using the `Vizarr <https://github.com/hms-dbmi/vizarr/>`_ viewer.

This omero-web app self-hosts Vizarr to avoid CORS issues (delegating to https://hms-dbmi.github.io/vizarr/).

Expand All @@ -71,7 +71,7 @@ Testing
-------

To run integration tests (in your omero-web conda environment above) with `pytest`.
See [OMERO testing docs](https://docs.openmicroscopy.org/latest/omero/developers/testing.html)
See `OMERO testing docs <https://docs.openmicroscopy.org/latest/omero/developers/testing.html>`_
for setting `ICE_CONFIG` and dependencies etc., then::

$ pytest test/integration/test_ngff.py
Expand Down