Merge branch 'main' into syntax-highlighting

acquire-project · Nov 6, 2023 · 1650498 · 1650498
2 parents b8c21b7 + dd7b0b5
commit 1650498
Show file tree

Hide file tree

Showing 13 changed files with 306 additions and 26 deletions.
diff --git a/docs/get_started.md b/docs/get_started.md
@@ -173,23 +173,21 @@ config.video[1].max_frame_count = 150 # collect 150 frames
 config = runtime.set_configuration(config)
 ```
 
----
-**NOTE**
+!!! note
 
-If you run this tutorial multiple times, you can clear output from previous runs with:
+    If you run this tutorial multiple times, you can clear output from previous runs with:
 
-```python
-import os
-import shutil
+    ```python
+    import os
+    import shutil
 
-if config.video[0].storage.settings.filename in os.listdir("."):
-    shutil.rmtree(config.video[0].storage.settings.filename)
-    
-if config.video[1].storage.settings.filename in os.listdir("."):
-    shutil.rmtree(config.video[1].storage.settings.filename)
-```
+    if config.video[0].storage.settings.filename in os.listdir("."):
+        shutil.rmtree(config.video[0].storage.settings.filename)
+
+    if config.video[1].storage.settings.filename in os.listdir("."):
+        shutil.rmtree(config.video[1].storage.settings.filename)
+    ```
 
----
 ## Acquire Data
 
 To start aquiring data:

diff --git a/docs/index.md b/docs/index.md
@@ -3,9 +3,9 @@
 acquire-python is a python package that provides a multi-camera video streaming
 library focusing on performant microscopy.
 
-```{note}
-This is an early stage project. If you find it interesting please reach out!
-```
+!!! note
+
+    This is an early stage project. If you find it interesting please reach out!
 
 Support for:
 

diff --git a/docs/stylesheets/custom.css b/docs/stylesheets/custom.css
@@ -1,3 +1,7 @@
+html {
+    --md-primary-fg-color: black !important;
+}
+
 .md-header {
     background-color: black;
 }
@@ -40,6 +44,109 @@
     color: white;
 }
 
+
 .md-typeset pre>code:hover {
     scrollbar-color: var(--md-accent-fg-color) #0000;
 }
+
+.md-nav--primary .md-nav__title .md-logo {
+display: none;
+}
+
+.md-nav--primary .md-nav__title {
+    height: 3rem;
+    padding-top: 0.3rem;
+    padding-left: 2rem;
+}
+
+.md-nav--primary .md-nav__title .md-nav__icon::after {
+    margin-top: 0.3rem;
+}
+
+
+@media screen and (max-width: 800px) {
+    .md-nav__source {
+        display: none;
+    }
+}
+
+.md-footer-meta__inner {
+    display: flex;
+    flex-direction: column;
+}
+
+.md-footer-meta__inner-social {
+    display: flex;
+    flex-direction: row;
+    margin-left: 0;
+    align-items: center;
+    justify-content: space-between;
+}
+
+.md-footer-meta__inner-social .links {
+    display: flex;
+    padding-left: 14px;
+}
+
+html .md-footer-meta.md-typeset a {
+    color: var(--md-footer-fg-color--light);
+    text-decoration: underline;
+}
+
+.md-header__links {
+    display: flex;
+    flex-direction: row;
+}
+
+.md-source {
+    font-weight: 700;
+    text-decoration: none !important;
+    display: flex;
+    align-items: center;
+    padding-right: 38px;
+    color: var(--md-footer-fg-color);
+    opacity: 0.7;
+}
+
+.md-source:hover {
+    opacity: 1;
+}
+
+.vl {
+    border-left: 2px solid white;
+    height: 42px;
+    opacity: 0.7;
+}
+
+.czi {
+    padding-left: 76px;
+}
+
+@media (max-width: 800px) {
+    .vl {
+        display: none;
+    }
+    .md-footer-meta__inner-social {
+        display: flex;
+        flex-direction: column;
+        align-self: flex-start;
+        padding-left: 1rem;
+    }
+    .md-footer-meta__inner-social .links {
+        padding-left: 0px;
+    }
+    .czi {
+        padding-left: 0px;
+    }
+    .md-source {
+        display: flex;
+        flex-direction: row;
+        align-items: center;
+        align-self: flex-start;
+        padding: 0.3rem 0 0.3rem 0;
+    }
+.md-footer__title:hover {
+    color: var(--md-accent-fg-color);
+}
+
+
diff --git a/docs/trigger.md → docs/tutorials/trigger.md b/docs/trigger.md → docs/tutorials/trigger.md
diff --git a/docs/tutorials.md → docs/tutorials/tutorials.md b/docs/tutorials.md → docs/tutorials/tutorials.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -5,6 +5,7 @@ theme:
   name: material
   features:
     - navigation.tabs
+    - navigation.tabs.sticky
     - navigation.footer
     - content.code.copy
   custom_dir: overrides
@@ -16,7 +17,9 @@ nav:
   - Home: index.md
   - Get Started: get_started.md
   - API Reference: api_reference.md
-  - Tutorials: tutorials.md
+  - Tutorials:
+    - tutorials/tutorials.md
+    - tutorials/trigger.md
   - For contributors: for_contributors.md
 
 extra:
@@ -32,3 +35,8 @@ markdown_extensions:
   - pymdownx.inlinehilite
   - pymdownx.snippets
   - pymdownx.superfences
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences
+
+
diff --git a/overrides/assets/images/CZI_Logotype.svg b/overrides/assets/images/CZI_Logotype.svg
diff --git a/overrides/assets/images/Icon-Github.svg b/overrides/assets/images/Icon-Github.svg