DOC: add an ASCII rendition of the test beamline, fix load-level docu…

…mentation rendering
pcdshub · Oct 31, 2024 · f3efe05 · f3efe05
1 parent 2434320
commit f3efe05
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/docs/source/yaml_files.rst b/docs/source/yaml_files.rst
@@ -76,8 +76,10 @@ amount of ophyd devices to load:
 
 - ``UPSTREAM``: The hutch's devices, and devices upstream from the requested hutch.
 If there are multiple paths to the requested hutch, all paths' devices are loaded.
+
 - ``STANDARD``: Devices gathered via ``UPSTREAM``, plus devices that share the
 "beamline" field in happi with the ``UPSTREAM`` devices.  (The current standard)
+
 - ``ALL``: All devices in the happi database.  Use this option at your own risk.
 
 .. code-block:: YAML

diff --git a/hutch_python/tests/conf.yaml b/hutch_python/tests/conf.yaml
@@ -1,5 +1,13 @@
 hutch: tst
 
+# Our test happi database has the following configuration:
+# tst_device_3 (inactive)
+
+# z +-> (0.8)               (1.0)           (2.0)
+# X0 -- tst_device_5 ------ tst_device_1 -- test_device_2 -- "TST"
+#                  \
+# Z0                -- tst_device_4 -- tst_device_6
+# z +->                (0.85)          (1.85)
 db: happi_db.json
 
 load: tst.beamline