Auto-update from Github Actions Workflow

Deployed from commit a23ac31 (refs/heads/master) Deployed from commit 07e78ad (refs/heads/master) Deployed from commit 91c4076 (refs/heads/master)
pcdshub · Sep 5, 2023 · 5d65638 · 5d65638
1 parent 26a45d5
commit 5d65638
Show file tree

Hide file tree

Showing 186 changed files with 29,314 additions and 240 deletions.
diff --git a/master/.buildinfo b/master/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 9f2ad08c54fa068edec25af51b885325
+config: 0a5cb2afd73d5c1a38cc502e2de580d4
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/master/_modules/atef/check.html b/master/_modules/atef/check.html
diff --git a/master/_modules/atef/config.html b/master/_modules/atef/config.html
diff --git a/master/_modules/atef/procedure.html b/master/_modules/atef/procedure.html
diff --git a/master/_modules/atef/tools.html b/master/_modules/atef/tools.html
diff --git a/master/_modules/index.html b/master/_modules/index.html
@@ -0,0 +1,112 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Overview: module code &mdash; atef  documentation</title>
+      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+      <link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
+  <!--[if lt IE 9]>
+    <script src="../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script src="../_static/jquery.js?v=5d32c60e"></script>
+        <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="../_static/documentation_options.js?v=5929fcd5"></script>
+        <script src="../_static/doctools.js?v=888ff710"></script>
+        <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+        <script src="../_static/docs-versions-menu.js?v=3d6a1aea"></script>
+    <script src="../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../index.html" class="icon icon-home">
+            atef
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api.html">ATEF API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../releases.html">Release History</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../upcoming_changes.html">Upcoming Changes</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Links</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/pcdshub/atef">Github Repository</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">atef</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Overview: module code</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="atef/check.html">atef.check</a></li>
+<li><a href="atef/config.html">atef.config</a></li>
+<li><a href="atef/procedure.html">atef.procedure</a></li>
+<li><a href="atef/tools.html">atef.tools</a></li>
+</ul>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2023, SLAC National Accelerator Laboratory.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/master/_sources/api.rst.txt b/master/_sources/api.rst.txt
@@ -7,7 +7,9 @@ Dataclasses
 
 .. autosummary::
     :toctree: generated
+    :recursive:
 
     atef.check
     atef.config
     atef.procedure
+    atef.tools
diff --git a/master/_sources/generated/atef.check.rst.txt b/master/_sources/generated/atef.check.rst.txt
@@ -9,20 +9,21 @@
 
 
 
-
-
-
-
    .. rubric:: Classes
 
    .. autosummary::
+      :toctree: generated
 
       AnyComparison
       AnyValue
+      BasicDynamic
       Comparison
+      DynamicValue
+      EpicsValue
       Equals
       Greater
       GreaterOrEqual
+      HappiValue
       Less
       LessOrEqual
       NotEquals
@@ -35,7 +36,4 @@
 
 
 
-
-
-
-
+
diff --git a/master/_sources/generated/atef.config.rst.txt b/master/_sources/generated/atef.config.rst.txt
@@ -5,13 +5,10 @@
 
 
 
-
-
-
-
    .. rubric:: Functions
 
    .. autosummary::
+      :toctree: generated
 
       get_result_from_comparison
       run_passive_step
@@ -23,6 +20,7 @@
    .. rubric:: Classes
 
    .. autosummary::
+      :toctree: generated
 
       Configuration
       ConfigurationFile
@@ -45,7 +43,4 @@
 
 
 
-
-
-
-
+
diff --git a/master/_sources/generated/atef.procedure.rst.txt b/master/_sources/generated/atef.procedure.rst.txt
@@ -5,14 +5,14 @@
 
 
 
-
-
-
-
    .. rubric:: Functions
 
    .. autosummary::
+      :toctree: generated
 
+      create_prepared_comparison
+      get_RE_data
+      get_bs_state
       walk_steps
 
 
@@ -22,20 +22,25 @@
    .. rubric:: Classes
 
    .. autosummary::
+      :toctree: generated
 
-      BlueskyState
       CodeStep
+      ComparisonToPlanData
       ComparisonToTarget
       ConfigurationCheckStep
       DescriptionStep
       DeviceConfiguration
       DisplayOptions
       FailedStep
       PassiveStep
+      PlanData
       PlanOptions
       PlanStep
       PreparedDescriptionStep
       PreparedPassiveStep
+      PreparedPlan
+      PreparedPlanComparison
+      PreparedPlanStep
       PreparedProcedureFile
       PreparedProcedureGroup
       PreparedProcedureStep
@@ -54,7 +59,4 @@
 
 
 
-
-
-
-
+
diff --git a/master/_sources/generated/atef.tools.rst.txt b/master/_sources/generated/atef.tools.rst.txt
@@ -0,0 +1,33 @@
+atef.tools
+==========
+
+.. automodule:: atef.tools
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+      :toctree: generated
+
+      get_result_value_by_key
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree: generated
+
+      Ping
+      PingResult
+      Tool
+      ToolResult
+
+
+
+
+
+
diff --git a/master/_sources/generated/generated/atef.check.AnyComparison.rst.txt b/master/_sources/generated/generated/atef.check.AnyComparison.rst.txt
@@ -0,0 +1,37 @@
+atef.check.AnyComparison
+========================
+
+.. currentmodule:: atef.check
+
+.. autoclass:: AnyComparison
+
+
+
+    .. rubric:: Methods
+
+
+    .. automethod:: __init__
+    .. automethod:: compare
+    .. automethod:: describe
+    .. automethod:: get_data_for_signal
+    .. automethod:: get_data_for_signal_async
+    .. automethod:: prepare
+
+
+
+
+
+    .. rubric:: Attributes
+
+
+    .. autoattribute:: description
+    .. autoattribute:: if_disconnected
+    .. autoattribute:: invert
+    .. autoattribute:: name
+    .. autoattribute:: reduce_method
+    .. autoattribute:: reduce_period
+    .. autoattribute:: severity_on_failure
+    .. autoattribute:: string
+    .. autoattribute:: comparisons
+
+
diff --git a/master/_sources/generated/generated/atef.check.AnyValue.rst.txt b/master/_sources/generated/generated/atef.check.AnyValue.rst.txt
@@ -0,0 +1,38 @@
+atef.check.AnyValue
+===================
+
+.. currentmodule:: atef.check
+
+.. autoclass:: AnyValue
+
+
+
+    .. rubric:: Methods
+
+
+    .. automethod:: __init__
+    .. automethod:: compare
+    .. automethod:: describe
+    .. automethod:: get_data_for_signal
+    .. automethod:: get_data_for_signal_async
+    .. automethod:: prepare
+
+
+
+
+
+    .. rubric:: Attributes
+
+
+    .. autoattribute:: description
+    .. autoattribute:: if_disconnected
+    .. autoattribute:: invert
+    .. autoattribute:: name
+    .. autoattribute:: reduce_method
+    .. autoattribute:: reduce_period
+    .. autoattribute:: severity_on_failure
+    .. autoattribute:: string
+    .. autoattribute:: values
+    .. autoattribute:: values_dynamic
+
+