search

napari / napari

napari: a fast, interactive, multi-dimensional image viewer for python
https://napari.org
BSD 3-Clause "New" or "Revised" License
2.2k stars 421 forks source link

update API reference page to include public APIs used in examples folder #3991

Open chili-chiu opened 2 years ago

chili-chiu commented 2 years ago

📚 Documentation

experimental_clipping_plane (in API reference but very little info) from: clipping_planes_interactive.py

napari.utils.transforms (not in API reference) from: interaction_box_image.py

napari.experimental.link_layers (not in API reference) from: linked_layers.py

napari.utils.theme (not in API reference) from: new_theme.py

naapri.Viewer.scale_bar (not in API reference) from: scale_bar.py

viewer.window.qt_viewer.canvas.measure_fps (not in API reference) from viewer_fps_label.py

experimental_slicing_plane (not in API reference) from volume_plane_rendering.py

sofroniewn commented 2 years ago

viewer.window.qt_viewer.canvas.measure_fps (not in API reference) from viewer_fps_label.py

This one is using an API that will become private in 0.5.0 I think - we might want to think about another way to expose it

melissawm commented 2 months ago

To date, here's the status:

experimental_clipping_plane (in API reference but very little info) from: clipping_planes_interactive.py

Now appears at https://napari.org/stable/api/napari.layers.Image.html#napari.layers.Image.experimental_clipping_planes

napari.utils.transforms (not in API reference) from: interaction_box_image.py

Now appears at https://napari.org/stable/api/napari.utils.transforms.html#module-napari.utils.transforms

napari.experimental.link_layers (not in API reference) from: linked_layers.py

Still missing

napari.utils.theme (not in API reference) from: new_theme.py

Appears in https://napari.org/stable/howtos/themes.html, https://napari.org/stable/gallery/set_theme.html, and https://napari.org/stable/api/napari.components.ViewerModel.html#napari.components.ViewerModel.theme but we should have full API documentation for napari.utils.theme?

napari.Viewer.scale_bar (not in API reference) from: scale_bar.py

Still missing

viewer.window.qt_viewer.canvas.measure_fps (not in API reference) from viewer_fps_label.py

Still missing

experimental_slicing_plane (not in API reference) from volume_plane_rendering.py

Still missing