Auto-update from Github Actions Workflow

Deployed from commit ef67fc4 (refs/tags/v1.5.1)
pcdshub · Sep 16, 2024 · 7230241 · 7230241
1 parent c4e6d06
commit 7230241
Show file tree

Hide file tree

Showing 238 changed files with 40,339 additions and 3 deletions.
diff --git a/index.html b/index.html
@@ -1,9 +1,9 @@
 <!DOCTYPE html>
 <html>
   <head>
-    <meta http-equiv="Refresh" content="0; url=v1.5.0" />
+    <meta http-equiv="Refresh" content="0; url=v1.5.1" />
   </head>
   <body>
-    <p>Go to the <a href="v1.5.0">default documentation</a>.</p>
+    <p>Go to the <a href="v1.5.1">default documentation</a>.</p>
   </body>
 </html>
diff --git a/v1.5.1/_modules/atef/check.html b/v1.5.1/_modules/atef/check.html
diff --git a/v1.5.1/_modules/atef/config.html b/v1.5.1/_modules/atef/config.html
diff --git a/v1.5.1/_modules/atef/procedure.html b/v1.5.1/_modules/atef/procedure.html
diff --git a/v1.5.1/_modules/atef/tools.html b/v1.5.1/_modules/atef/tools.html
diff --git a/v1.5.1/_modules/atef/walk.html b/v1.5.1/_modules/atef/walk.html
diff --git a/v1.5.1/_modules/index.html b/v1.5.1/_modules/index.html
@@ -0,0 +1,115 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="../">
+<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" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
+      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
+      <link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=fd3f3429" />
+
+
+  <!--[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=9a2dae69"></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>
+<li><a href="atef/walk.html">atef.walk</a></li>
+</ul>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, 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/v1.5.1/_sources/api.rst.txt b/v1.5.1/_sources/api.rst.txt
@@ -0,0 +1,16 @@
+ATEF API
+********
+
+
+Dataclasses
+^^^^^^^^^^^
+
+.. autosummary::
+    :toctree: generated
+    :recursive:
+
+    atef.check
+    atef.config
+    atef.procedure
+    atef.tools
+    atef.walk
diff --git a/v1.5.1/_sources/framework.rst.txt b/v1.5.1/_sources/framework.rst.txt
@@ -0,0 +1,12 @@
+ATEF Framework
+**************
+
+Checkout Structure
+^^^^^^^^^^^^^^^^^^
+
+To expand on:
+- Serializability
+- Prepared variants
+    - Prepared holds transient information (results)
+- Passive Checkout Groups
+- Active Checkout Verify control flow
diff --git a/v1.5.1/_sources/generated/atef.check.rst.txt b/v1.5.1/_sources/generated/atef.check.rst.txt
@@ -0,0 +1,39 @@
+atef.check
+==========
+
+.. automodule:: atef.check
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree: generated
+
+      AnyComparison
+      AnyValue
+      BasicDynamic
+      Comparison
+      DynamicValue
+      EpicsValue
+      Equals
+      Greater
+      GreaterOrEqual
+      HappiValue
+      Less
+      LessOrEqual
+      NotEquals
+      Range
+      Value
+      ValueRange
+      ValueSet
+
+
+
+
+
+
diff --git a/v1.5.1/_sources/generated/atef.config.rst.txt b/v1.5.1/_sources/generated/atef.config.rst.txt
@@ -0,0 +1,48 @@
+atef.config
+===========
+
+.. automodule:: atef.config
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+      :toctree: generated
+
+      get_result_from_comparison
+      run_passive_step
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree: generated
+
+      Configuration
+      ConfigurationFile
+      ConfigurationGroup
+      DeviceConfiguration
+      FailedConfiguration
+      PVConfiguration
+      PreparedComparison
+      PreparedConfiguration
+      PreparedDeviceConfiguration
+      PreparedFile
+      PreparedGroup
+      PreparedPVConfiguration
+      PreparedSignalComparison
+      PreparedTemplateConfiguration
+      PreparedToolComparison
+      PreparedToolConfiguration
+      TemplateConfiguration
+      ToolConfiguration
+
+
+
+
+
+
diff --git a/v1.5.1/_sources/generated/atef.procedure.rst.txt b/v1.5.1/_sources/generated/atef.procedure.rst.txt
@@ -0,0 +1,63 @@
+atef.procedure
+==============
+
+.. automodule:: atef.procedure
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+      :toctree: generated
+
+      create_prepared_comparison
+      get_RE_data
+      get_bs_state
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree: generated
+
+      CodeStep
+      ComparisonToPlanData
+      ComparisonToTarget
+      ConfigurationCheckStep
+      DescriptionStep
+      DeviceConfiguration
+      DisplayOptions
+      FailedStep
+      PassiveStep
+      PlanData
+      PlanOptions
+      PlanStep
+      PreparedDescriptionStep
+      PreparedPassiveStep
+      PreparedPlan
+      PreparedPlanComparison
+      PreparedPlanStep
+      PreparedProcedureFile
+      PreparedProcedureGroup
+      PreparedProcedureStep
+      PreparedSetValueStep
+      PreparedTemplateStep
+      PreparedValueToSignal
+      ProcedureFile
+      ProcedureGroup
+      ProcedureStep
+      PydmDisplayStep
+      SetValueStep
+      Target
+      TemplateStep
+      TyphosDisplayStep
+      ValueToTarget
+
+
+
+
+
+
diff --git a/v1.5.1/_sources/generated/atef.tools.rst.txt b/v1.5.1/_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/v1.5.1/_sources/generated/atef.walk.rst.txt b/v1.5.1/_sources/generated/atef.walk.rst.txt
@@ -0,0 +1,27 @@
+atef.walk
+=========
+
+.. automodule:: atef.walk
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+      :toctree: generated
+
+      get_prepared_step
+      get_relevant_configs_comps
+      walk_config_file
+      walk_procedure_file
+      walk_steps
+
+
+
+
+
+
+
+
+
+