ATEF API
+Dataclasses
+| + | + |
| + | + |
| + | Dataclasses for describing active checkout procedures. |
+
" +
+ "
";
+ menu.innerHTML = inner_html;
+ var parent = document.body;
+ parent.insertBefore(menu, parent.lastChild);
+
+ // Add a warning banner for dev/outdated versions
+ var warning;
+ var msg;
+ if (version_data["warnings"][current_folder].indexOf("outdated") >=0){
+ warning = document.createElement('div');
+ warning.setAttribute('class', 'admonition danger');
+ msg = "This document is for an outdated version.";
+ } else if (version_data["warnings"][current_folder].indexOf("unreleased") >=0){
+ warning = document.createElement('div');
+ warning.setAttribute('class', 'admonition danger');
+ msg = "This document is for an unreleased development version.";
+ } else if (version_data["warnings"][current_folder].indexOf("prereleased") >=0){
+ warning = document.createElement('div');
+ warning.setAttribute('class', 'admonition danger');
+ msg = "This document is for a pre-release development version.";
+ }
+ if (warning !== undefined){
+ if (version_data["latest"] !== null){
+ msg = msg + " Documentation is available for the " + "latest public release."
+ }
+ warning.innerHTML = "" +
+ "
" + + "Generated by Docs Versions Menu" + + "" + + "
" +
+ "- " +
+ "
- Versions "; + var i; + for (i in folders) { + var folder = folders[i]; + if (folder == current_folder){ + var inner_html = inner_html + "
- " + current_version + " "; + } else { + var inner_html = inner_html + "
- " + version_data["labels"][folder] + " "; + } + } + var downloads = version_data["downloads"][current_folder]; + if (downloads.length > 0){ + var inner_html = inner_html + + "
- Downloads "; + for (i in downloads) { + var download_label = downloads[i][0]; + var download_url = downloads[i][1]; + if (!(/^(https?|ftp):/.test(download_url))){ + if (!download_url.startsWith('/')){ + var download_url = '/' + download_url; + } + var download_url = root_url + download_url; + } + var inner_html = inner_html + "
- " + + download_label + " "; + } + } + var github_project_url = getGithubProjectUrl(); + if (github_project_url !== null && github_project_url.length > 0){ + var inner_html = inner_html + + "
- On Github " + + "
- Project Home " + + "
- Issues "; + } + var inner_html = inner_html + + "
" + + "Generated by Docs Versions Menu" + + "" + + "
Note
" + + "" + msg + "
"; + var parent = document.querySelector('div.body') + || document.querySelector('div.document') + || document.body; + parent.insertBefore(warning, parent.firstChild); + } + + +} + +function addVersionsMenu() { + // We assume that we can load versions.json from + // https://' + + '' + + _("Hide Search Matches") + + "
" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(SphinxHighlight.highlightSearchWords); +_ready(SphinxHighlight.initEscapeListener); diff --git a/v1.0.0/api.html b/v1.0.0/api.html new file mode 100644 index 00000000..5f678489 --- /dev/null +++ b/v1.0.0/api.html @@ -0,0 +1,141 @@ + + + + + + +
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/v1.0.0/framework.html b/v1.0.0/framework.html
new file mode 100644
index 00000000..a6a96259
--- /dev/null
+++ b/v1.0.0/framework.html
@@ -0,0 +1,127 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/v1.0.0/generated/atef.check.html b/v1.0.0/generated/atef.check.html
new file mode 100644
index 00000000..762697ef
--- /dev/null
+++ b/v1.0.0/generated/atef.check.html
@@ -0,0 +1,178 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/v1.0.0/generated/atef.config.html b/v1.0.0/generated/atef.config.html
new file mode 100644
index 00000000..ba32d509
--- /dev/null
+++ b/v1.0.0/generated/atef.config.html
@@ -0,0 +1,207 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ atef.check
+Classes
+
|
+Comparison passes if the value matches any comparison. |
+
|
+Comparison passes if the value is in the |
+
|
+Base class for all atef value comparisons. |
+
|
+
|
+
|
+Comparison: value > self.value. |
+
|
+Comparison: value >= self.value. |
+
|
+Comparison: value < self.value. |
+
|
+Comparison: value <= self.value. |
+
|
+
|
+
|
+A range comparison. |
+
|
+A primitive value with optional metadata. |
+
|
+A range of primitive values with optional metadata. |
+
|
+A set of values with corresponding severities and descriptions. |
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/v1.0.0/generated/atef.procedure.html b/v1.0.0/generated/atef.procedure.html
new file mode 100644
index 00000000..9c4726d4
--- /dev/null
+++ b/v1.0.0/generated/atef.procedure.html
@@ -0,0 +1,252 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ atef.config
+Functions
+
|
+Get a Result, if available, from the provided arguments. |
+
|
+Runs a given check and returns the result. |
+
Classes
+
|
+Configuration base class for shared settings between all configurations. |
+
|
+A configuration file comprised of a number of devices/PV configurations. |
+
|
+Configuration group. |
+
|
+A configuration that is built to check one or more devices. |
+
|
+A Configuration that failed to be prepared for running. |
+
|
+A configuration that is built to check live EPICS PVs. |
+
|
+A unified representation of comparisons for device signals and standalone PVs. |
+
|
+Base class for a Configuration that has been prepared to run. |
+
|
+
|
+
|
+Methods + |
+
|
+
|
+
|
+
|
+
|
+A unified representation of comparisons for device signals and standalone PVs. |
+
|
+A unified representation of comparisons for device signals and standalone PVs. |
+
|
+
|
+
|
+A configuration unrelated to PVs or Devices which verifies status via some tool. |
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/v1.0.0/genindex.html b/v1.0.0/genindex.html
new file mode 100644
index 00000000..829c2fe4
--- /dev/null
+++ b/v1.0.0/genindex.html
@@ -0,0 +1,161 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ atef.procedure
+Dataclasses for describing active checkout procedures. These dataclasses come in +normal (edit) and Prepared (run) variants
+Edit variants hold data needed to specify the step. +Prepared variants hold a reference to their originating edit-step, along with +Result objects and a .run() method.
+Adding a step requires: +- write the edit-variant +- add the edit-variant to the AnyProcedure type hint +- write the run-variant, along with its ._run() and .from_origin() methods +- add the step to PreparedProcedure.from_origin classmethod case statement
+Functions
+
|
+Yield ProedureSteps in |
+
Classes
+
|
++ |
|
+Run source code in a procedure. |
+
|
+
|
+
|
+Step which checks device configuration versus a given timestamp. |
+
|
+A simple title or descriptive step in the procedure. |
+
|
+Device configuration for comparison. |
+
|
+Options for a typhos or PyDM display. |
+
|
+A step that failed to be prepared for running. |
+
|
+A step that runs a passive checkout file |
+
|
+Options for a bluesky plan scan. |
+
|
+A procedure step comprised of one or more bluesky plans. |
+
|
+
|
+
|
+
|
+
|
+A Prepared Procedure file. |
+
|
+
|
+
|
+Base class for a ProcedureStep that has been prepared to run. |
+
|
+
|
+
|
+Methods + |
+
|
+File comprised of several Procedure steps |
+
|
+A group of procedure steps (or nested groups). |
+
|
+A basic step in an atef procedure. |
+
|
+A procedure step which a opens a PyDM display. |
+
|
+A step that sets one or more values and checks one or more values after |
+
|
+A destination for a value. |
+
|
+A procedure step which opens one or more typhos displays. |
+
|
+
|
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/v1.0.0/index.html b/v1.0.0/index.html
new file mode 100644
index 00000000..8646d8ee
--- /dev/null
+++ b/v1.0.0/index.html
@@ -0,0 +1,162 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+ + +A
+| + |
|
+
M
+
|
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/v1.0.0/objects.inv b/v1.0.0/objects.inv
new file mode 100644
index 00000000..72f38a18
Binary files /dev/null and b/v1.0.0/objects.inv differ
diff --git a/v1.0.0/py-modindex.html b/v1.0.0/py-modindex.html
new file mode 100644
index 00000000..25a4a987
--- /dev/null
+++ b/v1.0.0/py-modindex.html
@@ -0,0 +1,143 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+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.
+
+
+Contents:
+-
+
- ATEF API
-
+
- Dataclasses +
+ - Release History + +
- Upcoming Changes
-
+
+
+
+Indices and tables
+-
+
- +
- +
- +
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/v1.0.0/releases.html b/v1.0.0/releases.html
new file mode 100644
index 00000000..04d810bb
--- /dev/null
+++ b/v1.0.0/releases.html
@@ -0,0 +1,188 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Python Module Index
+ +
+ a
+
+
+ | + a | ||
| + |
+ atef | + |
| + |
+ atef.check | + |
| + |
+ atef.config | + |
| + |
+ atef.procedure | + |
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/v1.0.0/search.html b/v1.0.0/search.html
new file mode 100644
index 00000000..4355d909
--- /dev/null
+++ b/v1.0.0/search.html
@@ -0,0 +1,128 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 ofQTableWidgetthat 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
Comparisonwithin aProcedureStep
+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_exceptionnow properly expects to emit anException
+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
QDataclassBridgefor 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
HappiSearchWidgettree-view
+
Maintenance
+-
+
Improves
ResultStatusrefresh 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
SetValueSteprun 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/v1.0.0/searchindex.js b/v1.0.0/searchindex.js
new file mode 100644
index 00000000..6080152c
--- /dev/null
+++ b/v1.0.0/searchindex.js
@@ -0,0 +1 @@
+Search.setIndex({"docnames": ["api", "framework", "generated/atef.check", "generated/atef.config", "generated/atef.procedure", "index", "releases", "upcoming_changes", "upcoming_release_notes/template-full", "upcoming_release_notes/template-short"], "filenames": ["api.rst", "framework.rst", "generated/atef.check.rst", "generated/atef.config.rst", "generated/atef.procedure.rst", "index.rst", "releases.rst", "upcoming_changes.rst", "upcoming_release_notes/template-full.rst", "upcoming_release_notes/template-short.rst"], "titles": ["ATEF API", "ATEF Framework", "atef.check", "atef.config", "atef.procedure", "ATEF - Automated Test Execution Framework", "Release History", "Upcoming Changes", "IssueNumber Title", "IssueNumber Title"], "terms": {"To": 1, "expand": 1, "serializ": 1, "prepar": [1, 4], "variant": [1, 4], "hold": [1, 4], "transient": 1, "inform": 1, "result": [1, 4, 5, 6], "passiv": [1, 6], "group": 1, "activ": [1, 4, 6], "verifi": [1, 5, 6], "control": [1, 5], "flow": 1, "class": [2, 3, 4, 8], "function": [3, 4, 5, 6], "dataclass": [4, 5], "describ": 4, "checkout": [4, 5, 6], "These": [4, 8], "come": 4, "normal": 4, "edit": [4, 6], "run": [4, 5, 6], "data": 4, "need": [4, 8], "specifi": [4, 6], "step": [4, 6], "refer": 4, "origin": 4, "along": 4, "object": 4, "method": [4, 8], "ad": [4, 6], "requir": 4, "write": [4, 6], "add": [4, 6, 8], "anyprocedur": 4, "type": [4, 6], "hint": [4, 6], "its": 4, "_run": 4, "from_origin": 4, "preparedprocedur": 4, "classmethod": 4, "case": [4, 6], "statement": 4, "i": [5, 6, 8], "still": 5, "beta": 5, "featur": 5, "ar": [5, 8], "develop": 5, "bug": [5, 6, 8], "mai": 5, "have": [5, 6, 8], "slip": 5, "through": 5, "If": 5, "you": [5, 8], "ani": [5, 8], "feedback": 5, "we": 5, "would": [5, 6], "veri": 5, "much": 5, "appreci": 5, "leav": 5, "an": [5, 6], "issu": [5, 6, 8], "our": 5, "github": [5, 8], "repositori": 5, "initi": 5, "stand": 5, "meant": 5, "tailor": 5, "diagnost": 5, "procedur": 5, "us": [5, 6, 8], "system": 5, "It": 5, "provid": [5, 8], "collect": 5, "those": 5, "The": [5, 8], "concept": 5, "wai": 5, "everyon": 5, "build": 5, "can": [5, 6], "easili": 5, "consist": 5, "address": 5, "dynam": 5, "natur": 5, "entir": 5, "lcl": 5, "machin": 5, "establish": 5, "routin": 5, "perform": 5, "baselin": 5, "project": 5, "seek": 5, "combin": 5, "best": 5, "practic": 5, "softwar": 5, "favorit": 5, "packag": 5, "togeth": 5, "form": 5, "power": 5, "tool": 5, "maintain": 5, "api": 5, "releas": [5, 8], "histori": 5, "v1": 5, "0": 5, "2023": 5, "06": 5, "22": 5, "upcom": 5, "chang": [5, 6], "index": 5, "modul": 5, "search": 5, "page": 5, "mani": [6, 8], "taken": 6, "place": 6, "sinc": 6, "last": 6, "tag": [6, 8], "08": 6, "2022": 6, "now": 6, "insid": 6, "gui": 6, "been": 6, "prototyp": 6, "notabl": 6, "structur": 6, "file": 6, "befor": 6, "must": 6, "convert": 6, "modern": 6, "format": 6, "most": 6, "user": [6, 8], "thi": [6, 8], "shoutout": 6, "all": 6, "who": [6, 8], "help": 6, "pre": 6, "note": [6, 8], "framework": 6, "wa": 6, "replac": [6, 8], "welcom": 6, "dialog": 6, "land": 6, "tab": 6, "enabl": 6, "close": 6, "button": 6, "widget": 6, "passivestep": 6, "allow": 6, "compon": [6, 8], "enum": 6, "support": 6, "setvaluestep": 6, "": 6, "action": 6, "toth": 6, "suit": 6, "list": [6, 8], "set": 6, "valu": 6, "target": 6, "follow": 6, "check": 6, "comparison": 6, "succeed": 6, "tablewidgetwithaddrow": 6, "subclass": 6, "qtablewidget": 6, "includ": 6, "addrowwidget": 6, "row": 6, "contain": 6, "better": 6, "space": 6, "effici": 6, "within": 6, "procedurestep": 6, "busi": 6, "cursor": 6, "thread": 6, "worker": 6, "disabl": 6, "click": 6, "interact": 6, "wait": 6, "while": 6, "decor": 6, "recommend": 6, "necessari": 6, "when": [6, 8], "wrap": 6, "slot": 6, "creat": 6, "report": 6, "gener": 6, "fix": [6, 8], "where": 6, "fals": 6, "y": 6, "observ": 6, "fail": 6, "busycursorthread": 6, "raised_except": 6, "properli": 6, "expect": 6, "emit": 6, "except": 6, "more": 6, "nonetyp": 6, "handl": 6, "dure": 6, "onli": 6, "subscrib": 6, "onc": 6, "disconnect": 6, "update_valu": 6, "actionrowwidget": 6, "prevent": 6, "them": 6, "from": 6, "pile": 6, "up": 6, "whenev": 6, "signal": 6, "option": [6, 8], "qdataclassbridg": 6, "again": 6, "improv": 6, "miss": 6, "field": 6, "pars": 6, "carefulli": 6, "unsubscrib": 6, "callback": 6, "might": 6, "persist": 6, "after": 6, "toggl": 6, "between": 6, "mode": 6, "avoid": 6, "referenc": 6, "delet": 6, "runtre": 6, "cast": 6, "read": 6, "config": 6, "string": 6, "anyvalu": 6, "identifi": 6, "sequenc": 6, "base": [6, 8], "load": 6, "datatyp": 6, "devic": 6, "select": 6, "via": 6, "doubl": 6, "happisearchwidget": 6, "tree": 6, "view": 6, "resultstatu": 6, "refresh": 6, "also": 6, "updat": [6, 8], "paint": 6, "event": 6, "In": 6, "error": 6, "switch": 6, "reveal": 6, "revert": 6, "icon": 6, "behavior": [6, 8], "sigal": 6, "properti": 6, "configur": 6, "order": 6, "re": 6, "comput": 6, "overall_result": 6, "request": 6, "strai": 6, "sig": 6, "wait_for_connect": 6, "call": 6, "flesh": 6, "out": [6, 8], "test": 6, "fixtur": 6, "appropri": [6, 8], "displai": 6, "differenti": 6, "pv": [6, 8], "ophyddevicetableview": 6, "get": 6, "input": 6, "valid": 6, "tangkong": 6, "abov": 8, "your": 8, "number": 8, "1": 8, "2": 8, "word": 8, "filenam": 8, "should": 8, "rst": 8, "substitut": 8, "make": 8, "sure": 8, "fill": 8, "section": 8, "repres": 8, "made": 8, "default": 8, "bullet": 8, "point": 8, "n": [8, 9], "A": [8, 9], "backward": 8, "incompat": 8, "here": 8, "don": 8, "t": 8, "count": 8, "librari": 8, "name": 8, "doe": 8, "new": 8, "util": 8, "helper": 8, "etc": 8, "cover": 8, "anyth": 8, "els": 8, "intent": 8, "accumul": 8, "averag": 8, "worri": 8, "about": 8, "usernam": 8, "anyon": 8, "signific": 8, "code": 8, "conceptu": 8, "contribut": 8, "pr": 8, "review": 8, "unless": 8, "suggest": 8, "lead": 8, "larg": 8, "rewrit": 8, "give": 8, "credit": 8, "notifi": 8, "being": 8}, "objects": {"atef": [[2, 0, 0, "-", "check"], [3, 0, 0, "-", "config"], [4, 0, 0, "-", "procedure"]]}, "objtypes": {"0": "py:module"}, "objnames": {"0": ["py", "module", "Python module"]}, "titleterms": {"atef": [0, 1, 2, 3, 4, 5], "api": [0, 8, 9], "dataclass": 0, "framework": [1, 5], "checkout": 1, "structur": 1, "check": 2, "config": 3, "procedur": 4, "autom": 5, "test": 5, "execut": 5, "disclaim": 5, "background": 5, "content": 5, "indic": 5, "tabl": 5, "releas": 6, "histori": 6, "v1": 6, "0": 6, "2023": 6, "06": 6, "22": 6, "featur": [6, 8, 9], "bugfix": [6, 8, 9], "mainten": [6, 8, 9], "contributor": [6, 8, 9], "upcom": 7, "chang": [7, 8, 9], "issuenumb": [8, 9], "titl": [8, 9]}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.viewcode": 1, "sphinx": 57}, "alltitles": {"ATEF API": [[0, "atef-api"]], "Dataclasses": [[0, "dataclasses"]], "ATEF Framework": [[1, "atef-framework"]], "Checkout Structure": [[1, "checkout-structure"]], "atef.check": [[2, "module-atef.check"]], "atef.config": [[3, "module-atef.config"]], "atef.procedure": [[4, "module-atef.procedure"]], "ATEF - Automated Test Execution Framework": [[5, "atef-automated-test-execution-framework"]], "Disclaimer": [[5, "disclaimer"]], "Background": [[5, "background"]], "Contents:": [[5, null]], "Indices and tables": [[5, "indices-and-tables"]], "Release History": [[6, "release-history"]], "v1.0.0 (2023-06-22)": [[6, "v1-0-0-2023-06-22"]], "Features": [[6, "features"], [8, "features"], [9, "features"]], "Bugfixes": [[6, "bugfixes"], [8, "bugfixes"], [9, "bugfixes"]], "Maintenance": [[6, "maintenance"], [8, "maintenance"], [9, "maintenance"]], "Contributors": [[6, "contributors"], [8, "contributors"], [9, "contributors"]], "Upcoming Changes": [[7, "upcoming-changes"]], "IssueNumber Title": [[8, "issuenumber-title"], [9, "issuenumber-title"]], "API Changes": [[8, "api-changes"], [9, "api-changes"]]}, "indexentries": {"atef.check": [[2, "module-atef.check"]], "module": [[2, "module-atef.check"], [3, "module-atef.config"], [4, "module-atef.procedure"]], "atef.config": [[3, "module-atef.config"]], "atef.procedure": [[4, "module-atef.procedure"]]}})
\ No newline at end of file
diff --git a/v1.0.0/upcoming_changes.html b/v1.0.0/upcoming_changes.html
new file mode 100644
index 00000000..22369735
--- /dev/null
+++ b/v1.0.0/upcoming_changes.html
@@ -0,0 +1,119 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/v1.0.0/upcoming_release_notes/template-full.html b/v1.0.0/upcoming_release_notes/template-full.html
new file mode 100644
index 00000000..751a7c93
--- /dev/null
+++ b/v1.0.0/upcoming_release_notes/template-full.html
@@ -0,0 +1,154 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Upcoming Changes
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/v1.0.0/upcoming_release_notes/template-short.html b/v1.0.0/upcoming_release_notes/template-short.html
new file mode 100644
index 00000000..47294efc
--- /dev/null
+++ b/v1.0.0/upcoming_release_notes/template-short.html
@@ -0,0 +1,142 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+