diff --git a/.codespellrc b/.codespellrc index 1cf75e5e7..c8cf9f3c0 100644 --- a/.codespellrc +++ b/.codespellrc @@ -1,4 +1,4 @@ [codespell] # Ref: https://github.com/codespell-project/codespell#using-a-config-file -skip = *.ai,*.css,*.ipynb,*.py,*.svg,.git*,./ruff_cache/,./.venv_*,gallery,.codespellrc,EULA.md,docs/release/index.md +skip = *.ai,*.css,*.ipynb,*.py,*.svg,.git*,./ruff_cache/,./.venv_*,gallery,.codespellrc,EULA.md,./docs/release/index.md ignore-words = .codespell/ignore-words.txt diff --git a/.mdformat.toml b/.mdformat.toml index 50a43501a..81f989cab 100644 --- a/.mdformat.toml +++ b/.mdformat.toml @@ -1,3 +1,4 @@ exclude = [ "docs/naps/*.md", + "docs/release/index.md", ] diff --git a/docs/_static/images/3d_cells.png b/docs/_static/images/3d_cells.png new file mode 100644 index 000000000..36a5b527f Binary files /dev/null and b/docs/_static/images/3d_cells.png differ diff --git a/docs/_static/images/open_3d.png b/docs/_static/images/open_3d.png new file mode 100644 index 000000000..a8a610c7b Binary files /dev/null and b/docs/_static/images/open_3d.png differ diff --git a/docs/_static/images/open_image.png b/docs/_static/images/open_image.png new file mode 100644 index 000000000..e0afbe28f Binary files /dev/null and b/docs/_static/images/open_image.png differ diff --git a/docs/_static/images/toggle_3d_cells.png b/docs/_static/images/toggle_3d_cells.png new file mode 100644 index 000000000..5a18aa7d1 Binary files /dev/null and b/docs/_static/images/toggle_3d_cells.png differ diff --git a/docs/_toc.yml b/docs/_toc.yml index c0b6c5b42..8ee0e3c7c 100644 --- a/docs/_toc.yml +++ b/docs/_toc.yml @@ -5,51 +5,39 @@ 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: howtos/layers/index + subtrees: + - titlesonly: True + entries: + - file: howtos/layers/image + - file: howtos/layers/labels + - file: howtos/layers/shapes + - file: howtos/layers/points + - file: howtos/layers/tracks + - file: howtos/layers/vectors + - file: howtos/layers/surface - 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 entries: - - file: howtos/layers/index - subtrees: - - titlesonly: True - entries: - - file: howtos/layers/image - - file: howtos/layers/labels - - file: howtos/layers/points - - file: howtos/layers/shapes - - file: howtos/layers/surface - - file: howtos/layers/tracks - - file: howtos/layers/vectors - file: howtos/extending/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/further-resources/napari-workshops.md b/docs/further-resources/napari-workshops.md index 8db18bb32..c46ec4daf 100644 --- a/docs/further-resources/napari-workshops.md +++ b/docs/further-resources/napari-workshops.md @@ -1,6 +1,6 @@ (workshops)= -# napari workshops +# Workshops There have been many workshops and tutorials given about napari. This page contains a list, to make them easier to find online. 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