Add documentation page

CAVEconnectome · Jan 3, 2024 · 662f495 · 662f495
1 parent e7a06fd
commit 662f495
Show file tree

Hide file tree

Showing 88 changed files with 15,011 additions and 44 deletions.
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1 @@
+/.quarto/
diff --git a/docs/_quarto.yml b/docs/_quarto.yml
@@ -0,0 +1,60 @@
+project:
+  title: "ImageryClient"
+  type: website
+
+website:
+  title: "ImageryClient"
+  page-navigation: true
+  navbar:
+    left:
+      - text: Getting Started
+        href: getting_started.qmd
+      - text: Tutorials
+        menu:
+          - tutorials/images.qmd
+          - tutorials/overlays.qmd
+      - href: reference/index.qmd
+        text: Function Reference
+    tools:
+      - icon: github
+        text: Github
+        href: http://github.com/AllenInstitute/ImageryClient
+
+format:
+  html:
+    toc: true
+
+theme:
+  - flatly
+
+metadata-files:
+  - _sidebar.yml
+
+quartodoc:
+  style: 'pkgdown'
+  title: ''
+  sidebar: _sidebar.yml
+  dir: reference
+  out_index: _api_index.qmd
+  package: imageryclient
+  parser: numpy
+  sections:
+    - title: ImageryClient
+      desc: Main functions for downloading imagery and segmentation data.
+      contents:
+        - imagery.bounds_from_center
+        - name: imagery.ImageryClient
+          children: flat 
+    - title: Compositing
+      desc: Functions for generating overlay visualizations of images and segmentation.
+      contents:
+      - composite.stack_images
+      - composite.composite_overlay
+    - title: Utilities
+      desc: Additional utility functions for working with imagery and segmentation data.
+      contents:
+      - utils.rescale_to_bounds
+      - utils.binary_seg_outline
+      - utils.mask_image
+      - utils.segmentation_masks
+
diff --git a/docs/_sidebar.yml b/docs/_sidebar.yml
@@ -0,0 +1,20 @@
+website:
+  sidebar:
+  - contents:
+    - reference/index.qmd
+    - contents:
+      - reference/imagery.bounds_from_center.qmd
+      - reference/imagery.ImageryClient.qmd
+      section: ImageryClient
+    - contents:
+      - reference/composite.stack_images.qmd
+      - reference/composite.composite_overlay.qmd
+      section: Compositing
+    - contents:
+      - reference/utils.rescale_to_bounds.qmd
+      - reference/utils.binary_seg_outline.qmd
+      - reference/utils.mask_image.qmd
+      - reference/utils.segmentation_masks.qmd
+      section: Utilities
+    id: reference
+  - id: dummy-sidebar
diff --git a/docs/_site/example_images/code_to_picture.png b/docs/_site/example_images/code_to_picture.png
diff --git a/docs/_site/example_images/exact_mip_3.png b/docs/_site/example_images/exact_mip_3.png
diff --git a/docs/_site/example_images/img_base.png b/docs/_site/example_images/img_base.png
diff --git a/docs/_site/example_images/microns_example.png b/docs/_site/example_images/microns_example.png
diff --git a/docs/_site/example_images/scaled_mip_3.png b/docs/_site/example_images/scaled_mip_3.png
diff --git a/docs/_site/example_images/seg_base.png b/docs/_site/example_images/seg_base.png
diff --git a/docs/_site/example_images/seg_outline_0.png b/docs/_site/example_images/seg_outline_0.png
diff --git a/docs/_site/example_images/seg_outline_1.png b/docs/_site/example_images/seg_outline_1.png
diff --git a/docs/_site/example_images/seg_overlay_0.png b/docs/_site/example_images/seg_overlay_0.png
diff --git a/docs/_site/example_images/seg_overlay_1.png b/docs/_site/example_images/seg_overlay_1.png
diff --git a/docs/_site/example_images/seg_overlay_2.png b/docs/_site/example_images/seg_overlay_2.png
diff --git a/docs/_site/example_images/seg_series_0.png b/docs/_site/example_images/seg_series_0.png
diff --git a/docs/_site/example_images/seg_series_full.png b/docs/_site/example_images/seg_series_full.png
diff --git a/docs/_site/example_images/seg_single.png b/docs/_site/example_images/seg_single.png
diff --git a/docs/_site/example_images/seg_specific.png b/docs/_site/example_images/seg_specific.png
diff --git a/docs/_site/getting_started.html b/docs/_site/getting_started.html