Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/docs/api-reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,10 @@ icon: material/code-braces-box

This section contains the reference detailing the functions and modules
available in EasyImaging.

- [Measurement](measurement/measurement.md) - Loads and inspects
measurement data.
- [regions_of_interest](regions_of_interest/index.md) - This module
contains all types of Regions Of Interests (ROIs) available:
- [RectangleROI](regions_of_interest/rectangle_roi.md) - A rectangular
ROI. The most basic and common type of ROI
5 changes: 5 additions & 0 deletions docs/docs/api-reference/measurement/measurement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
icon: fontawesome/solid/microscope
---

::: easyimaging.Measurement
11 changes: 11 additions & 0 deletions docs/docs/api-reference/regions_of_interest/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
icon: fontawesome/solid/crop-simple
---

# :fontawesome-solid-crop-simple: Regions Of Interest (ROIs)

This module contains the different kinds of Regions Of Interest (ROIs)
available in EasyImaging. More will be added at a later date

- [RectangleROI](rectangle_roi.md) - A rectangular ROI. The most basic
and common type of ROI
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
::: easyimaging.regions_of_interest.RectangleROI
Binary file added docs/docs/assets/images/crosshairs_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/assets/images/crosshairs_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/assets/images/vector-square_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/assets/images/vector-square_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 8 additions & 1 deletion docs/docs/assets/stylesheets/extra.css
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,14 @@ label.md-nav__title[for="__drawer"] {

/* Change the overall width of the page */
.md-grid {
max-width: 1280px;
max-width: 116em;
}

/* Keep prose line length stable when sidebars are hidden at narrower widths */
.md-main .md-content > .md-content__inner {
width: min(100%, 40.5em);
margin-left: auto !important;
margin-right: auto !important;
}

/* Needed for mkdocs-jupyter to show download and other buttons on top of the notebook */
Expand Down
Loading