From f3efe05640eef13a00183436d2d1952b952de796 Mon Sep 17 00:00:00 2001 From: tangkong Date: Thu, 31 Oct 2024 11:51:15 -0700 Subject: [PATCH] DOC: add an ASCII rendition of the test beamline, fix load-level documentation rendering --- docs/source/yaml_files.rst | 2 ++ hutch_python/tests/conf.yaml | 8 ++++++++ 2 files changed, 10 insertions(+) diff --git a/docs/source/yaml_files.rst b/docs/source/yaml_files.rst index 5bc1f0b8..e48b9818 100644 --- 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 index 2ef12195..c3b067d6 100644 --- 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