Auto-update from Github Actions Workflow

Deployed from commit 8281d22 (refs/tags/v1.0.0) Deployed from commit 8281d22 (refs/tags/v1.0.0)
pcdshub · Jun 22, 2023 · 26a45d5 · 26a45d5
1 parent d969f88
commit 26a45d5
Show file tree

Hide file tree

Showing 66 changed files with 7,496 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=master" />
+    <meta http-equiv="Refresh" content="0; url=v1.0.0" />
   </head>
   <body>
-    <p>Go to the <a href="master">default documentation</a>.</p>
+    <p>Go to the <a href="v1.0.0">default documentation</a>.</p>
   </body>
 </html>
diff --git a/v1.0.0/.buildinfo b/v1.0.0/.buildinfo
@@ -0,0 +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
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v1.0.0/.nojekyll b/v1.0.0/.nojekyll
diff --git a/v1.0.0/_sources/api.rst.txt b/v1.0.0/_sources/api.rst.txt
@@ -0,0 +1,13 @@
+ATEF API
+********
+
+
+Dataclasses
+^^^^^^^^^^^
+
+.. autosummary::
+    :toctree: generated
+
+    atef.check
+    atef.config
+    atef.procedure
diff --git a/v1.0.0/_sources/framework.rst.txt b/v1.0.0/_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.0.0/_sources/generated/atef.check.rst.txt b/v1.0.0/_sources/generated/atef.check.rst.txt
@@ -0,0 +1,41 @@
+atef.check
+==========
+
+.. automodule:: atef.check
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      AnyComparison
+      AnyValue
+      Comparison
+      Equals
+      Greater
+      GreaterOrEqual
+      Less
+      LessOrEqual
+      NotEquals
+      Range
+      Value
+      ValueRange
+      ValueSet
+
+
+
+
+
+
+
+
+
diff --git a/v1.0.0/_sources/generated/atef.config.rst.txt b/v1.0.0/_sources/generated/atef.config.rst.txt
@@ -0,0 +1,51 @@
+atef.config
+===========
+
+.. automodule:: atef.config
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      get_result_from_comparison
+      run_passive_step
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Configuration
+      ConfigurationFile
+      ConfigurationGroup
+      DeviceConfiguration
+      FailedConfiguration
+      PVConfiguration
+      PreparedComparison
+      PreparedConfiguration
+      PreparedDeviceConfiguration
+      PreparedFile
+      PreparedGroup
+      PreparedPVConfiguration
+      PreparedSignalComparison
+      PreparedToolComparison
+      PreparedToolConfiguration
+      ToolConfiguration
+
+
+
+
+
+
+
+
+
diff --git a/v1.0.0/_sources/generated/atef.procedure.rst.txt b/v1.0.0/_sources/generated/atef.procedure.rst.txt
@@ -0,0 +1,60 @@
+atef.procedure
+==============
+
+.. automodule:: atef.procedure
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      walk_steps
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      BlueskyState
+      CodeStep
+      ComparisonToTarget
+      ConfigurationCheckStep
+      DescriptionStep
+      DeviceConfiguration
+      DisplayOptions
+      FailedStep
+      PassiveStep
+      PlanOptions
+      PlanStep
+      PreparedDescriptionStep
+      PreparedPassiveStep
+      PreparedProcedureFile
+      PreparedProcedureGroup
+      PreparedProcedureStep
+      PreparedSetValueStep
+      PreparedValueToSignal
+      ProcedureFile
+      ProcedureGroup
+      ProcedureStep
+      PydmDisplayStep
+      SetValueStep
+      Target
+      TyphosDisplayStep
+      ValueToTarget
+
+
+
+
+
+
+
+
+
diff --git a/v1.0.0/_sources/index.rst.txt b/v1.0.0/_sources/index.rst.txt
@@ -0,0 +1,50 @@
+ATEF - Automated Test Execution Framework
+=========================================
+
+Disclaimer
+^^^^^^^^^^
+
+ATEF is still in beta; features are still in development and bugs may have slipped
+through.  If you have any feedback, we would very much appreciate you leaving an
+issue in our `github repository <https://github.com/pcdshub/atef>`_.
+
+Background
+^^^^^^^^^^
+
+Atef is an initialism that stands for "Automated Test Execution Framework."
+Atef is meant to be a framework tailored for automating checkout and diagnostic
+procedures using the control system. It will provide functionality for
+automating checkout procedures, and the collection of the results of those
+checkout procedures. The concept is to provide a way for everyone to build
+checkout procedures that can be run in the control system easily, and
+consistently. It is meant to address the dynamic nature of the entire system
+(the LCLS machine), by providing a way to establish and routinely verify a
+performance baseline. The project seeks to combine the best practices and
+features of software testing automation, and our favorite control system
+automation packages together to form a powerful tool for maintaining our
+systems.
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   api.rst
+   releases.rst
+   upcoming_changes.rst
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Links
+   :hidden:
+
+   Github Repository <https://github.com/pcdshub/atef>
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/v1.0.0/_sources/releases.rst.txt b/v1.0.0/_sources/releases.rst.txt
@@ -0,0 +1,59 @@
+Release History
+###############
+
+
+v1.0.0 (2023-06-22)
+========================
+Many changes have taken place since the last tag (08/2022).  Checkouts can now
+be run inside the GUI, and active checkouts have been prototyped.
+
+Notably the structure of the checkout files changed, and checkouts before that
+tag must be converted to the modern format.  Most users will not have issues
+with this.
+
+Shoutout to all the contributors who helped before the pre-release notes framework
+was added.
+
+Features
+--------
+- Replaces the welcome dialog with a welcome landing tab
+- Enable the close-tab button
+- adds run and edit widgets for ``PassiveStep``, a step that allows passive checkouts to be run as a component of an active checkout
+- Adds Enum support to the ``SetValueStep``'s actions
+- Adds SetValueStep tothe active checkout suite, allowing for a list of actions to be taken (setting values to targets), followed by a list of checks (Comparisons) for verifying the actions succeeded.
+- Adds a ``TableWidgetWithAddRow``, a subclass of ``QTableWidget`` that includes a AddRowWidget. This add row contains a button for adding rows of a specified widget. (for better space efficiency)
+- Adds GUI support for placing a ``Comparison`` within a ``ProcedureStep``
+- Adds a busy cursor Thread worker (disables click interaction and changes to a wait cursor while a function runs) and a busy cursor decorator (not recommended, but necessary when wrapping slots that create widgets)
+- Adds report generation for active checkouts
+
+Bugfixes
+--------
+- Fixes a bug where False-y observed values would fail to be reported
+- ``BusyCursorThread.raised_exception`` now properly expects to emit an ``Exception``
+- fixes more NoneType handling bugs during report generation.
+- only subscribe the close-tab function once.
+- disconnect update_value slots in ``ActionRowWidget``, preventing them from piling up whenever signal type changes.
+- Fixes optional type hint handling in ``QDataclassBridge`` (again)
+- Improve missing field handling in report generation
+- fixes type hint parsing in ``QDataclassBridge`` for Optional type hints.
+- carefully unsubscribes callbacks that might persist after toggling between run and edit mode, avoiding slots from referencing deleted RunTree widgets
+- Cast values read from the config to a string in AnyValue widget
+- Properly identify up Sequences in ``QDataclassBridge``
+- Sets the comparison widget type based on the loaded datatype
+- Allows device selection via double-click in the ``HappiSearchWidget`` tree-view
+
+Maintenance
+-----------
+- Improves ``ResultStatus`` refresh handling, now also updates on paint events
+- In the case of errors during a mode switch, the error will be revealed to the user and the switch will be reverted.
+- Improve result icon refresh behavior by emitting a sigal whenever a step is run.
+- Add result property to passive checkout configurations in order to re-compute the overall_result when .result is requested.
+- places a stray sig.wait_for_connection call into a ``BusyCursorThread``
+- fleshes out the test suite, adding fixtures where appropriate.
+- display enum strings in ``SetValueStep`` run view.
+- Differentiates between read and write (set) PV's in ``OphydDeviceTableView``
+- Wraps signal.get call used for setting input type validators in ``BusyCursorThread``
+
+Contributors
+------------
+- tangkong
diff --git a/v1.0.0/_sources/upcoming_changes.rst.txt b/v1.0.0/_sources/upcoming_changes.rst.txt
@@ -0,0 +1,8 @@
+Upcoming Changes
+################
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   upcoming_release_notes/[0-9]*
diff --git a/v1.0.0/_sources/upcoming_release_notes/template-full.rst.txt b/v1.0.0/_sources/upcoming_release_notes/template-full.rst.txt
@@ -0,0 +1,36 @@
+IssueNumber Title
+#################
+
+Update the title above with your issue number and a 1-2 word title.
+Your filename should be issuenumber-title.rst, substituting appropriately.
+
+Make sure to fill out any section that represents changes you have made,
+or replace the default bullet point with N/A.
+
+API Changes
+-----------
+- List backwards-incompatible changes here.
+  Changes to PVs don't count as API changes for this library,
+  but changing method and component names or changing default behavior does.
+
+Features
+--------
+- List new updates that add utility to many classes,
+  provide a new base classes, add options to helper methods, etc.
+
+Bugfixes
+--------
+- List bug fixes that are not covered in the above sections.
+
+Maintenance
+-----------
+- List anything else. The intent is to accumulate changes
+  that the average user does not need to worry about.
+
+Contributors
+------------
+- List your github username and anyone else who made significant
+  code or conceptual contributions to the PR. You don't need to
+  add reviewers unless their suggestions lead to large rewrites.
+  These will be used in the release notes to give credit and to
+  notify you when your code is being tagged.
diff --git a/v1.0.0/_sources/upcoming_release_notes/template-short.rst.txt b/v1.0.0/_sources/upcoming_release_notes/template-short.rst.txt
@@ -0,0 +1,22 @@
+IssueNumber Title
+#################
+
+API Changes
+-----------
+- N/A
+
+Features
+--------
+- N/A
+
+Bugfixes
+--------
+- N/A
+
+Maintenance
+-----------
+- N/A
+
+Contributors
+------------
+- N/A