Initial commit of documentation

Deployed from commit bfc9b88 (refs/heads/master) Deployed from commit 8ef9b33 (refs/heads/master) Deployed from commit 707f995 (refs/heads/master) Deployed from commit 67194a6 (refs/heads/master) Deployed from commit c3c54bd (refs/heads/master) Deployed from commit 6073b4d (refs/heads/master) Deployed from commit 1c28e47 (refs/heads/master) Deployed from commit 2dbd9e1 (refs/heads/master) Deployed from commit 7cc33ef (refs/heads/master) Deployed from commit 032336c (refs/heads/master) Deployed from commit eb09405 (refs/heads/master) Deployed from commit 4576f44 (refs/heads/master) Deployed from commit 6528c74 (refs/heads/master) Deployed from commit dc7ded7 (refs/heads/master) Deployed from commit 6d44dc9 (refs/heads/master)
pcdshub · Aug 2, 2024 · e64bacf · e64bacf
commit e64bacf
Show file tree

Hide file tree

Showing 85 changed files with 8,504 additions and 0 deletions.
diff --git a/.nojekyll b/.nojekyll
diff --git a/index.html b/index.html
@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Refresh" content="0; url=master" />
+  </head>
+  <body>
+    <p>Go to the <a href="master">default documentation</a>.</p>
+  </body>
+</html>
diff --git a/master/.buildinfo b/master/.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: 2515237a6cfa08e954272b211e282dc8
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/master/.nojekyll b/master/.nojekyll
diff --git a/master/_sources/index.rst.txt b/master/_sources/index.rst.txt
@@ -0,0 +1,27 @@
+.. superscore documentation master file, created by
+   sphinx-quickstart on Tue May 22 13:13:05 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to superscore's documentation!
+===========================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Links
+   :hidden:
+
+   Github Repository <https://github.com/pcdshub/superscore>
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/master/_sources/upcoming_changes.rst.txt b/master/_sources/upcoming_changes.rst.txt
@@ -0,0 +1,8 @@
+Upcoming Changes
+################
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   upcoming_release_notes/[0-9]*
diff --git a/master/_sources/upcoming_release_notes/2-enh_main_window.rst.txt b/master/_sources/upcoming_release_notes/2-enh_main_window.rst.txt
@@ -0,0 +1,22 @@
+2 enh_main_window
+#################
+
+API Breaks
+----------
+- N/A
+
+Features
+--------
+- Adds main window widget and cli entrypoint skeleton
+
+Bugfixes
+--------
+- N/A
+
+Maintenance
+-----------
+- Updates dependencies, adds pre-release notes framework
+
+Contributors
+------------
+- tangkong
diff --git a/master/_sources/upcoming_release_notes/24-enh_client_backend.rst.txt b/master/_sources/upcoming_release_notes/24-enh_client_backend.rst.txt
@@ -0,0 +1,22 @@
+24 enh_client_backend
+#####################
+
+API Breaks
+----------
+- N/A
+
+Features
+--------
+- Add skeleton for Client and Backend base class
+
+Bugfixes
+--------
+- N/A
+
+Maintenance
+-----------
+- N/A
+
+Contributors
+------------
+- tangkong
diff --git a/master/_sources/upcoming_release_notes/25-enh_filestore_backend.rst.txt b/master/_sources/upcoming_release_notes/25-enh_filestore_backend.rst.txt
@@ -0,0 +1,25 @@
+25 enh_filestore_backend
+########################
+
+API Breaks
+----------
+- N/A
+
+Features
+--------
+- Adds FilestoreBackend
+- Adds Root for holding top-level Entry objects
+- Adds UUID to potentially lazy fields
+
+Bugfixes
+--------
+- N/A
+
+Maintenance
+-----------
+- Set up backend fixtures, sample database, and sample database
+- Make Setpoint and Readback into direct Entry subclasses for ease of serialization
+
+Contributors
+------------
+- tangkong
diff --git a/...sources/upcoming_release_notes/27-Add_testing_backend_and_linac_fixture.rst.txt b/...sources/upcoming_release_notes/27-Add_testing_backend_and_linac_fixture.rst.txt
@@ -0,0 +1,25 @@
+27 Add testing backend and linac fixture
+#################
+
+API Breaks
+----------
+- N/A
+
+Features
+--------
+- Add custom exceptions: BackendError, FileExistsError, FileNotFoundError
+- Add TestBackend: an in-memory backend for testing purposes
+- Add LINAC Collection test fixture
+
+Bugfixes
+--------
+- N/A
+
+Maintenance
+-----------
+- Document that _Backend.delete_entry raises error when entry is out-of-sync with backend
+- Document that _Backend.get_entry raises error when entry can't be found
+
+Contributors
+------------
+- shilorigins
diff --git a/master/_sources/upcoming_release_notes/28-entry_validation.rst.txt b/master/_sources/upcoming_release_notes/28-entry_validation.rst.txt
@@ -0,0 +1,23 @@
+28 entry validation
+#################
+
+API Breaks
+----------
+- N/A
+
+Features
+--------
+- Add validation methods to Entry and all subclasses
+
+Bugfixes
+--------
+- N/A
+
+Maintenance
+-----------
+- Add Snapshot test fixture mirroring the LINAC Collection
+- Introduce Nestable class interface
+
+Contributors
+------------
+- shilorigins
diff --git a/master/_sources/upcoming_release_notes/35-enh_control_layer.rst.txt b/master/_sources/upcoming_release_notes/35-enh_control_layer.rst.txt
@@ -0,0 +1,23 @@
+35 enh_control_layer
+####################
+
+API Breaks
+----------
+- N/A
+
+Features
+--------
+- Adds shim layer for aioca (async Channel Access)
+- Adds ControlLayer class for communicating with shims
+
+Bugfixes
+--------
+- N/A
+
+Maintenance
+-----------
+- N/A
+
+Contributors
+------------
+- tangkong
diff --git a/master/_sources/upcoming_release_notes/38-gui_main_window.rst.txt b/master/_sources/upcoming_release_notes/38-gui_main_window.rst.txt
@@ -0,0 +1,22 @@
+38 gui_main_window
+##################
+
+API Breaks
+----------
+- N/A
+
+Features
+--------
+- Adds DataWidget, RootModel, and related qt helpers
+
+Bugfixes
+--------
+- N/A
+
+Maintenance
+-----------
+- N/A
+
+Contributors
+------------
+- tangkong
diff --git a/master/_sources/upcoming_release_notes/5-add_dataclass_skeletons.rst.txt b/master/_sources/upcoming_release_notes/5-add_dataclass_skeletons.rst.txt
@@ -0,0 +1,22 @@
+5 add dataclass skeletons
+#################
+
+API Breaks
+----------
+- N/A
+
+Features
+--------
+- Add dataclasses and simple serialization tests
+
+Bugfixes
+--------
+- N/A
+
+Maintenance
+-----------
+- N/A
+
+Contributors
+------------
+- shilorigins
diff --git a/master/_sources/upcoming_release_notes/53-enh_client_apply.rst.txt b/master/_sources/upcoming_release_notes/53-enh_client_apply.rst.txt
@@ -0,0 +1,22 @@
+53 enh_client_apply
+###################
+
+API Breaks
+----------
+- N/A
+
+Features
+--------
+- Implements `Client.apply` method for writing values from `Entry` data to the control system.
+
+Bugfixes
+--------
+- N/A
+
+Maintenance
+-----------
+- Adjusts `TaskStatus` use to properly capture exceptions.
+
+Contributors
+------------
+- tangkong
diff --git a/master/_sources/upcoming_release_notes/54-enh_config_client.rst.txt b/master/_sources/upcoming_release_notes/54-enh_config_client.rst.txt
@@ -0,0 +1,22 @@
+54 enh_config_client
+####################
+
+API Breaks
+----------
+- N/A
+
+Features
+--------
+- Adds ability for Client to search for configuration files, and load settings from them.
+
+Bugfixes
+--------
+- N/A
+
+Maintenance
+-----------
+- N/A
+
+Contributors
+------------
+- tangkong
diff --git a/master/_sources/upcoming_release_notes/56-gui_search_page.rst.txt b/master/_sources/upcoming_release_notes/56-gui_search_page.rst.txt
@@ -0,0 +1,23 @@
+56 gui_search_page
+##################
+
+API Breaks
+----------
+- N/A
+
+Features
+--------
+- Adds SearchPage for filtering and viewing Entry objects
+
+Bugfixes
+--------
+- N/A
+
+Maintenance
+-----------
+- Allow relative paths for backend filestore location
+- Adjust FilestoreBackend search method to permit some special arguments and special search types.
+
+Contributors
+------------
+- tangkong
diff --git a/master/_sources/upcoming_release_notes/57-snapshot_saving.rst.txt b/master/_sources/upcoming_release_notes/57-snapshot_saving.rst.txt
@@ -0,0 +1,23 @@
+57 snapshot saving
+#################
+
+API Breaks
+----------
+- N/A
+
+Features
+--------
+- ability to save Snapshots for a Collection
+
+Bugfixes
+--------
+- N/A
+
+Maintenance
+-----------
+- generalized Client._gather_data to work on any type of Entry
+- made Client._gather_data iterative rather than recursive to simplify the conditional logic
+
+Contributors
+------------
+- shilorigins
diff --git a/master/_sources/upcoming_release_notes/63-bug_fs_newline.rst.txt b/master/_sources/upcoming_release_notes/63-bug_fs_newline.rst.txt
@@ -0,0 +1,22 @@
+63 bug_fs_newline
+#################
+
+API Breaks
+----------
+- N/A
+
+Features
+--------
+- N/A
+
+Bugfixes
+--------
+- Add newline to end of file when writing filestore json
+
+Maintenance
+-----------
+- N/A
+
+Contributors
+------------
+- tangkong
diff --git a/master/_sources/upcoming_release_notes/64-gui_open_page.rst.txt b/master/_sources/upcoming_release_notes/64-gui_open_page.rst.txt
@@ -0,0 +1,23 @@
+64 gui_open_page
+################
+
+API Breaks
+----------
+- N/A
+
+Features
+--------
+- adds ``Window.open_page(entry)`` for opening an ``Entry`` in a new tab
+- Adds icons to represent various ``Entry`` subclasses
+
+Bugfixes
+--------
+- N/A
+
+Maintenance
+-----------
+- N/A
+
+Contributors
+------------
+- tangkong