Merge pull request #8 from blakeNaccarato/6-write-the-instrument-usag…

…e-tutorial Write the instrument usage tutorial
blakeNaccarato · May 1, 2024 · cd79fb8 · cd79fb8
2 parents eb80bc8 + b9ea3b4
commit cd79fb8
Show file tree

Hide file tree

Showing 100 changed files with 306 additions and 106 deletions.
diff --git a/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml
@@ -2,6 +2,8 @@ fix: true
 ignores: ["tests/**"]
 config:
   default: true
+  blanks-around-fences: false # Test
   first-line-h1: false
   line-length: false
   no-duplicate-heading: false
+  no-space-in-emphasis: false # Test
diff --git a/changelog/8.change.md b/changelog/8.change.md
@@ -0,0 +1 @@
+Write the instrument usage tutorial
diff --git a/changelog/towncrier_template.md.jinja b/changelog/towncrier_template.md.jinja
@@ -5,6 +5,7 @@ These changes reflect the current [development progress](https://github.com/blak
 :::
 {# CHANGELOG.md entries #}{% else -%}
 ## [{{ versiondata["version"] }}](https://github.com/blakeNaccarato/c-therm-tci/tree/{{ versiondata["version"] }}){% endif %}
+
 {% for section, _ in sections.items() %}
 
 {% for category, val in definitions.items() if category in sections[section] %}

diff --git a/docs/_static/01.png b/docs/_static/01.png
diff --git a/docs/_static/02.png b/docs/_static/02.png
diff --git a/docs/_static/03.png b/docs/_static/03.png
diff --git a/docs/_static/04.png b/docs/_static/04.png
diff --git a/docs/_static/05.png b/docs/_static/05.png
diff --git a/docs/_static/06.png b/docs/_static/06.png
diff --git a/docs/_static/07.png b/docs/_static/07.png
diff --git a/docs/_static/08.png b/docs/_static/08.png
diff --git a/docs/_static/09.png b/docs/_static/09.png
diff --git a/docs/_static/10.png b/docs/_static/10.png
diff --git a/docs/_static/11.png b/docs/_static/11.png
diff --git a/docs/_static/12.png b/docs/_static/12.png
diff --git a/docs/_static/13.png b/docs/_static/13.png
diff --git a/docs/_static/14.png b/docs/_static/14.png
diff --git a/docs/_static/15.png b/docs/_static/15.png
diff --git a/docs/_static/16.png b/docs/_static/16.png
diff --git a/docs/_static/17.png b/docs/_static/17.png
diff --git a/docs/_static/18.png b/docs/_static/18.png
diff --git a/docs/_static/19.png b/docs/_static/19.png
diff --git a/docs/_static/20.png b/docs/_static/20.png
diff --git a/docs/_static/21.png b/docs/_static/21.png
diff --git a/docs/_static/22.png b/docs/_static/22.png
diff --git a/docs/_static/23.png b/docs/_static/23.png
diff --git a/docs/_static/24.png b/docs/_static/24.png
diff --git a/docs/_static/25.png b/docs/_static/25.png
diff --git a/docs/_static/26.png b/docs/_static/26.png
diff --git a/docs/_static/27.png b/docs/_static/27.png
diff --git a/docs/_static/28.png b/docs/_static/28.png
diff --git a/docs/_static/29.png b/docs/_static/29.png
diff --git a/docs/_static/30.png b/docs/_static/30.png
diff --git a/docs/_static/31.png b/docs/_static/31.png
diff --git a/docs/_static/32.png b/docs/_static/32.png
diff --git a/docs/_static/33.png b/docs/_static/33.png
diff --git a/docs/_static/34.png b/docs/_static/34.png
diff --git a/docs/_static/35.png b/docs/_static/35.png
diff --git a/docs/_static/36.png b/docs/_static/36.png
diff --git a/docs/_static/37.png b/docs/_static/37.png
diff --git a/docs/_static/38.png b/docs/_static/38.png
diff --git a/docs/_static/39.png b/docs/_static/39.png
diff --git a/docs/_static/40.png b/docs/_static/40.png
diff --git a/docs/_static/41.png b/docs/_static/41.png
diff --git a/docs/_static/42.png b/docs/_static/42.png
diff --git a/docs/_static/43.jpg b/docs/_static/43.jpg
diff --git a/docs/_static/44.jpg b/docs/_static/44.jpg
diff --git a/docs/_static/45.jpg b/docs/_static/45.jpg
diff --git a/docs/_static/47.jpg b/docs/_static/47.jpg
diff --git a/docs/_static/tutorial/00-01-ref.jpg b/docs/_static/tutorial/00-01-ref.jpg
diff --git a/docs/_static/tutorial/00-02-ref.jpg b/docs/_static/tutorial/00-02-ref.jpg
diff --git a/docs/_static/tutorial/00-04-turn-on.jpg b/docs/_static/tutorial/00-04-turn-on.jpg
diff --git a/docs/_static/tutorial/00-05-language.png b/docs/_static/tutorial/00-05-language.png
diff --git a/docs/_static/tutorial/00-06-capped.jpg b/docs/_static/tutorial/00-06-capped.jpg
diff --git a/docs/_static/tutorial/00-06-desktop-software-indicated.png b/docs/_static/tutorial/00-06-desktop-software-indicated.png
diff --git a/docs/_static/tutorial/00-07-login.png b/docs/_static/tutorial/00-07-login.png
diff --git a/docs/_static/tutorial/00-08-manage.png b/docs/_static/tutorial/00-08-manage.png
diff --git a/docs/_static/tutorial/00-09-four-drops.jpg b/docs/_static/tutorial/00-09-four-drops.jpg
diff --git a/docs/_static/tutorial/00-09-manage-dialog-important-options.png b/docs/_static/tutorial/00-09-manage-dialog-important-options.png
diff --git a/docs/_static/tutorial/00-10-sample-placed.jpg b/docs/_static/tutorial/00-10-sample-placed.jpg
diff --git a/docs/_static/tutorial/00-11-weight-placed.jpg b/docs/_static/tutorial/00-11-weight-placed.jpg
diff --git a/docs/_static/tutorial/00-12-ring-stand.jpg b/docs/_static/tutorial/00-12-ring-stand.jpg
diff --git a/docs/_static/tutorial/00-13-ring-stand-close.jpg b/docs/_static/tutorial/00-13-ring-stand-close.jpg
diff --git a/docs/_static/tutorial/00-14-wipe.jpg b/docs/_static/tutorial/00-14-wipe.jpg
diff --git a/docs/_static/tutorial/00-15-damage-will-occur.png b/docs/_static/tutorial/00-15-damage-will-occur.png
diff --git a/docs/_static/tutorial/00-16-safer.jpg b/docs/_static/tutorial/00-16-safer.jpg
diff --git a/docs/_static/tutorial/00-17-blotter.jpg b/docs/_static/tutorial/00-17-blotter.jpg
diff --git a/docs/_static/tutorial/00-18-laptop.jpg b/docs/_static/tutorial/00-18-laptop.jpg
diff --git a/docs/_static/tutorial/01-add-material-group.png b/docs/_static/tutorial/01-add-material-group.png
diff --git a/docs/_static/tutorial/02-save-material-group.png b/docs/_static/tutorial/02-save-material-group.png
diff --git a/docs/_static/tutorial/03-add-material.png b/docs/_static/tutorial/03-add-material.png
diff --git a/docs/_static/tutorial/05-save-lot.png b/docs/_static/tutorial/05-save-lot.png
diff --git a/docs/_static/tutorial/06-save-project.png b/docs/_static/tutorial/06-save-project.png
diff --git a/docs/_static/tutorial/07-test-method.png b/docs/_static/tutorial/07-test-method.png
diff --git a/docs/_static/tutorial/08-00-save-test-method.png b/docs/_static/tutorial/08-00-save-test-method.png
diff --git a/docs/_static/tutorial/08-01-relationships-1.png b/docs/_static/tutorial/08-01-relationships-1.png
diff --git a/docs/_static/tutorial/08-02-relatoinships-2.png b/docs/_static/tutorial/08-02-relatoinships-2.png
diff --git a/docs/_static/tutorial/09-new-test.png b/docs/_static/tutorial/09-new-test.png
diff --git a/docs/_static/tutorial/10-select-project.png b/docs/_static/tutorial/10-select-project.png
diff --git a/docs/_static/tutorial/11-00-select-test-method.png b/docs/_static/tutorial/11-00-select-test-method.png
diff --git a/docs/_static/tutorial/11-01-select-material.png b/docs/_static/tutorial/11-01-select-material.png
diff --git a/docs/_static/tutorial/12-select-instrument.png b/docs/_static/tutorial/12-select-instrument.png
diff --git a/docs/_static/tutorial/13-new-lot-prompt.png b/docs/_static/tutorial/13-new-lot-prompt.png
diff --git a/docs/_static/tutorial/14-warmup.png b/docs/_static/tutorial/14-warmup.png
diff --git a/docs/_static/tutorial/15-measuring.png b/docs/_static/tutorial/15-measuring.png
diff --git a/docs/_static/tutorial/16-check-good.png b/docs/_static/tutorial/16-check-good.png
diff --git a/docs/_static/tutorial/17-bad-example.png b/docs/_static/tutorial/17-bad-example.png
diff --git a/docs/_static/tutorial/18-good-example.png b/docs/_static/tutorial/18-good-example.png
diff --git a/docs/_static/tutorial/19-interrupt.png b/docs/_static/tutorial/19-interrupt.png
diff --git a/docs/_static/tutorial/20-overlay.png b/docs/_static/tutorial/20-overlay.png
diff --git a/docs/_static/tutorial/21-overlay-chart.png b/docs/_static/tutorial/21-overlay-chart.png
diff --git a/docs/_static/tutorial/22-tests.png b/docs/_static/tutorial/22-tests.png
diff --git a/docs/_static/tutorial/23-export-tests.png b/docs/_static/tutorial/23-export-tests.png
diff --git a/docs/_static/tutorial/24-retrieve-all.png b/docs/_static/tutorial/24-retrieve-all.png
diff --git a/docs/_static/tutorial/25-select-all.png b/docs/_static/tutorial/25-select-all.png
diff --git a/docs/_static/tutorial/26-select-path.png b/docs/_static/tutorial/26-select-path.png
diff --git a/docs/_static/tutorial/27-finish-export.png b/docs/_static/tutorial/27-finish-export.png
diff --git a/docs/_static/tutorial/28-wildcard-search.png b/docs/_static/tutorial/28-wildcard-search.png
diff --git a/docs/conf.py b/docs/conf.py
@@ -165,8 +165,10 @@ def dpath(path: Path, rel: Path = DOCS) -> str:
 nb_execution_mode = "cache"
 nb_execution_raise_on_error = True
 # ! Other
+numfig = True
 math_eqref_format = "Eq. {number}"
 mermaid_d3_zoom = False
+suppress_warnings = ["design.grid"]
 # ! Autodoc2
 nitpicky = True
 autodoc2_packages = [
@@ -185,15 +187,14 @@ def dpath(path: Path, rel: Path = DOCS) -> str:
 autodoc2_docstring_parser_regexes = [(".*", f"{PACKAGE}_docs.docstrings")]
 # ! Intersphinx
 intersphinx_mapping = ISPX_MAPPING
-nitpick_ignore = [
-    # ? Not found
-    ("py:class", "parsel.Selector")
-]
+nitpick_ignore = []
 nitpick_ignore_regex = [
     # ? Missing inventory
     (r"py:.*", r"docutils\..+"),
     (r"py:.*", r"numpydoc\.docscrape\..+"),
     (r"py:.*", r"_pytest\..+"),
+    # ? Not found
+    (r"py:.*", r"parsel\.Selector.*"),
     # ? TypeAlias: https://github.com/sphinx-doc/sphinx/issues/10785
     (r"py:.*", rf"{PACKAGE}.*\.types\..+"),
 ]

diff --git a/docs/tutorial.md b/docs/tutorial.md