diff --git a/README.md b/README.md index 3a22d6a6..cb7a98c7 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,15 @@ We welcome contributions to the Acquire code base and to documentation. Refer to ## Build -To build the website locally and serve it, run the following commands: +To build the website locally and serve it, after cloning and successfully installing `acquire-imaging` and +`acquire-zarr` in developer mode, run the following commands: ```bash pip install -r requirements.txt mkdocs serve ``` + +> [!NOTE] +> This setup assumes you have acquire-python and acquire-zarr cloned in the same +> parent directory as acquire-docs. If this is not the case, edit the +> [`mkdocs.yml` file](https://github.com/acquire-project/acquire-docs/blob/main/mkdocs.yml) accordingly. diff --git a/docs/stream_to_zarr/index.md b/docs/stream_to_zarr/index.md new file mode 100644 index 00000000..f967acff --- /dev/null +++ b/docs/stream_to_zarr/index.md @@ -0,0 +1,28 @@ +--- +title: Stream to Zarr +template: home_zarr.html +--- + +
+
+

Python API Reference

+

Information on classes and methods

+ Python API Reference +
+
+

C API Reference

+

Information on classes and methods

+ C API Reference +
+
+

Python Tests

+

Integration tests that demonstrate how to use the python library

+ Python Tests +
+
+

C Tests

+

Integration tests that demonstrate how to use the C library

+ C Tests +
+
+ diff --git a/mkdocs.yml b/mkdocs.yml index af593a83..b21232f9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -62,6 +62,8 @@ nav: - for_contributors/index.md - for_contributors/docs_contribution_quickstart.md - for_contributors/update_version.md + - Stream to Zarr: + - stream_to_zarr/index.md markdown_extensions: - pymdownx.highlight: @@ -93,7 +95,7 @@ plugins: python: # Global-only options load_external_modules: true - paths: [../acquire-python/python/acquire] + paths: [../acquire-python/python/acquire, ../acquire-zarr/python/acquire] import: - https://docs.python.org/3/objects.inv options: # See https://mkdocstrings.github.io/python/usage/#globallocal-options diff --git a/overrides/home_zarr.html b/overrides/home_zarr.html new file mode 100644 index 00000000..93ac25f4 --- /dev/null +++ b/overrides/home_zarr.html @@ -0,0 +1,95 @@ + + +{% extends "main.html" %} + +{% block header %} +{% include "./partials/header.html" %} +{% endblock %} + + +{% block tabs %} +{{ super() }} + + + + + +
+
+
+ +
+

Stream to Zarr

+

The Acquire Zarr Streaming library supports chunked, compressed, multiscale streaming to + Zarr, with + OME-NGFF metadata.

+ + Get Started + +
+
+
+
+{% endblock %} + + +{% block content %} + {{ super() }} + +{% endblock %} + + +{% block footer %} +{% include "./partials/footer.html" %} +{% endblock %}