From 05de75a35ee2c77dee7269ed0734c9bad452f87f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Melissa=20Weber=20Mendon=C3=A7a?= Date: Wed, 29 Oct 2025 15:51:09 +0900 Subject: [PATCH 01/16] WIP --- docs/_toc.yml | 36 +- .../contributing/documentation/index.md | 2 +- .../features.md | 10 +- docs/getting_started/installation.md | 430 +++++++++++++ .../launch_napari.md} | 11 +- docs/{guides => getting_started}/layers.md | 0 docs/getting_started/open_images.md | 1 + .../quick_start.md | 50 +- .../start_index.md | 0 .../viewer.md | 33 +- docs/howtos/layers/image.md | 4 +- docs/howtos/layers/labels.md | 2 +- docs/howtos/layers/points.md | 4 +- docs/howtos/layers/shapes.md | 2 +- docs/howtos/layers/surface.md | 2 +- docs/howtos/layers/tracks.md | 2 +- docs/howtos/layers/vectors.md | 2 +- docs/release/index.md | 593 +++++++++++++++++- .../{annotation => }/annotate_points.md | 0 .../annotate_segmentation.md | 1 + docs/tutorials/annotation/index.md | 7 - .../tutorials/{tracking => }/cell_tracking.md | 1 + docs/tutorials/{processing => }/dask.md | 0 docs/tutorials/fundamentals/installation.md | 252 -------- .../fundamentals/installation_bundle_conda.md | 205 ------ docs/tutorials/index.md | 4 +- docs/tutorials/processing/index.md | 7 - docs/tutorials/segmentation/index.md | 7 - docs/tutorials/tracking/index.md | 7 - 29 files changed, 1083 insertions(+), 592 deletions(-) rename docs/{tutorials/fundamentals => getting_started}/features.md (91%) create mode 100644 docs/getting_started/installation.md rename docs/{tutorials/fundamentals/getting_started.md => getting_started/launch_napari.md} (95%) rename docs/{guides => getting_started}/layers.md (100%) create mode 100644 docs/getting_started/open_images.md rename docs/{tutorials/fundamentals => getting_started}/quick_start.md (80%) rename docs/{tutorials => getting_started}/start_index.md (100%) rename docs/{tutorials/fundamentals => getting_started}/viewer.md (96%) rename docs/tutorials/{annotation => }/annotate_points.md (100%) rename docs/tutorials/{segmentation => }/annotate_segmentation.md (99%) delete mode 100644 docs/tutorials/annotation/index.md rename docs/tutorials/{tracking => }/cell_tracking.md (99%) rename docs/tutorials/{processing => }/dask.md (100%) delete mode 100644 docs/tutorials/fundamentals/installation.md delete mode 100644 docs/tutorials/fundamentals/installation_bundle_conda.md delete mode 100644 docs/tutorials/processing/index.md delete mode 100644 docs/tutorials/segmentation/index.md delete mode 100644 docs/tutorials/tracking/index.md diff --git a/docs/_toc.yml b/docs/_toc.yml index c0b6c5b42..412bbff8c 100644 --- a/docs/_toc.yml +++ b/docs/_toc.yml @@ -5,36 +5,24 @@ subtrees: subtrees: - titlesonly: True entries: - - file: tutorials/start_index + - file: getting_started/quick_start + - file: getting_started/start_index subtrees: - titlesonly: True entries: - - file: tutorials/fundamentals/quick_start - - file: tutorials/fundamentals/installation - - file: tutorials/fundamentals/installation_bundle_conda - - file: tutorials/fundamentals/getting_started - - file: tutorials/fundamentals/viewer - - file: tutorials/fundamentals/features - - file: guides/layers + - file: getting_started/installation + - file: getting_started/launch_napari + - file: getting_started/open_images + - file: getting_started/viewer + - file: getting_started/layers + - file: getting_started/features - file: tutorials/index subtrees: - entries: - - file: tutorials/annotation/index - subtrees: - - entries: - - file: tutorials/annotation/annotate_points - - file: tutorials/processing/index - subtrees: - - entries: - - file: tutorials/processing/dask - - file: tutorials/segmentation/index - subtrees: - - entries: - - file: tutorials/segmentation/annotate_segmentation - - file: tutorials/tracking/index - subtrees: - - entries: - - file: tutorials/tracking/cell_tracking + - file: tutorials/annotate_points + - file: tutorials/dask + - file: tutorials/annotate_segmentation + - file: tutorials/cell_tracking - file: howtos/index subtrees: - titlesonly: True diff --git a/docs/developers/contributing/documentation/index.md b/docs/developers/contributing/documentation/index.md index 26a0d70a9..e78fed1f4 100644 --- a/docs/developers/contributing/documentation/index.md +++ b/docs/developers/contributing/documentation/index.md @@ -513,7 +513,7 @@ You will need: ```bash python -m pip install -e ".[pyqt]" --group docs ``` - This will use the default Qt backend. For other options, see [the napari installation guide](../../../tutorials/fundamentals/installation.md#choosing-a-different-qt-backend). + This will use the default Qt backend. For other options, see [the napari installation guide](choosing-qt-backend). ````{note} You can combine the documentation dependencies with [a development installation of napari](dev-installation) by selecting the Qt extra and both dependency groups, e.g. installing with `.[pyqt]` and adding `--group dev --group docs`. diff --git a/docs/tutorials/fundamentals/features.md b/docs/getting_started/features.md similarity index 91% rename from docs/tutorials/fundamentals/features.md rename to docs/getting_started/features.md index a213c0281..9447c7e80 100644 --- a/docs/tutorials/fundamentals/features.md +++ b/docs/getting_started/features.md @@ -35,9 +35,9 @@ keys to make a selection. Once you have the action you want highlighted, press ```{raw} html