Merge pull request #337 from dstansby/doc-structure

Improve documentation structure
ome · Dec 7, 2023 · 6810035 · 6810035
2 parents 77b16af + cc16cc9
commit 6810035
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 59 deletions.
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -1,8 +1,8 @@
-API
-===
+Python API
+==========
 
 .. toctree::
-    :maxdepth: 3
+    :maxdepth: 2
 
     api/cli
     api/csv

diff --git a/docs/source/cli.rst b/docs/source/cli.rst
@@ -1,5 +1,5 @@
 
-Command-line Tool
+Command-line tool
 -----------------
 
 Open Zarr filesets containing images with associated OME metadata.

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,18 +1,46 @@
-Welcome to ome-zarr-py documentation
-====================================
+===========
+ome-zarr-py
+===========
 
-**ome zarr** is a Python library for reading and writing multi-resolution images stored
-as Zarr filesets, according to the `OME NGFF spec`_.
+Tools for reading and writing multi-resolution images stored in Zarr filesets, according to the `OME NGFF spec`_.
 
 
-Contents
+Features
 --------
 
+- :doc:`cli` for reading and downloading OME-NGFF filesets.
+- :doc:`api` for reading and writing OME-NGFF filesets (see :doc:`python` for example usage).
+- Used by the `napari-ome-zarr`_ plugin for viewing OME-NGFF filesets in `napari`_.
+
+Contents
+--------
 .. toctree::
+   :maxdepth: 1
 
-   intro
    cli
    python
    api
 
+Installation
+------------
+
+Install the latest release of `ome-zarr`_ from PyPI::
+
+    pip install ome-zarr
+
+or from conda-forge::
+
+    conda install -c conda-forge ome-zarr
+
+
+License
+-------
+
+Distributed under the terms of the `BSD`_ license,
+"ome-zarr-py" is free and open source software
+
 .. _`OME NGFF spec`: https://github.com/ome/ngff
+.. _`BSD`: https://opensource.org/licenses/BSD-2-Clause
+.. _`napari`: https://github.com/napari/napari
+.. _`napari-ome-zarr`: https://github.com/ome/napari-ome-zarr
+.. _`ome-zarr`: https://pypi.org/project/ome-zarr/
diff --git a/docs/source/intro.rst b/docs/source/intro.rst
diff --git a/docs/source/python.rst b/docs/source/python.rst
@@ -1,5 +1,5 @@
-ome_zarr Python library
-=======================
+Python tutorial
+===============
 
 Writing OME-NGFF images
 -----------------------