Auto-update from Github Actions Workflow

Deployed from commit 00e39a3 (refs/heads/master)

Deployed from commit 8bfca4c (refs/heads/master)

Deployed from commit 5f39b19 (refs/heads/master)

Deployed from commit f571da5 (refs/heads/master)

Deployed from commit 1185e27 (refs/heads/master)

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: 06400b06278b95ed6211b639e8a69bc8
+config: 89804061efaa21d653c4d0c3d93b89b0
 tags: 645f666f9bcd5a90fca523b33c5a78b7

master/_sources/releases.rst.txt

@@ -2,6 +2,27 @@ Release History
 ###############
 
 
+v1.21.0 (2024-08-20)
+====================
+
+Features
+--------
+- Automatically timeout and closes hutch-python sessions after the user has been
+  idle for a certain number of hours. The number of hours can be set in conf.yml
+  for each hutch. If no value is set the default timeout duration is 48 hours.
+
+Maintenance
+-----------
+- Document some first-pass efforts at running hutch-python in jupyter notebooks.
+- Fix an issue where an upstream numpy 2 incompatibilty was breaking the pypi builds.
+
+Contributors
+------------
+- janeliu-slac
+- zllentz
+
+
+
 v1.20.0 (2024-04-19)
 ====================
 

master/_static/documentation_options.js

@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '1.19.1.dev17+ga2b1b55',
+    VERSION: '1.20.1.dev80+g1185e270',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

master/_static/searchtools.js

@@ -178,7 +178,7 @@ const Search = {
 
   htmlToText: (htmlString, anchor) => {
     const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
-    for (const removalQuery of [".headerlinks", "script", "style"]) {
+    for (const removalQuery of [".headerlink", "script", "style"]) {
       htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
     }
     if (anchor) {
@@ -328,13 +328,14 @@ const Search = {
     for (const [title, foundTitles] of Object.entries(allTitles)) {
       if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
         for (const [file, id] of foundTitles) {
-          let score = Math.round(100 * queryLower.length / title.length)
+          const score = Math.round(Scorer.title * queryLower.length / title.length);
+          const boost = titles[file] === title ? 1 : 0;  // add a boost for document titles
           normalResults.push([
             docNames[file],
             titles[file] !== title ? `${titles[file]} > ${title}` : title,
             id !== null ? "#" + id : "",
             null,
-            score,
+            score + boost,
             filenames[file],
           ]);
         }

master/beamline.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Beamline File &mdash; hutch-python 1.19.1.dev17+ga2b1b55 documentation</title>
+  <title>Beamline File &mdash; hutch-python 1.20.1.dev80+g1185e270 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" />
 
@@ -15,7 +15,7 @@
 
         <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=197f51f2"></script>
+        <script src="_static/documentation_options.js?v=852d77fc"></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>
@@ -39,7 +39,7 @@
             hutch-python
           </a>
               <div class="version">
-                1.19.1.dev17+ga2b1b55
+                1.20.1.dev80+g1185e270
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

master/bug.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>bug.py &mdash; hutch-python 1.19.1.dev17+ga2b1b55 documentation</title>
+  <title>bug.py &mdash; hutch-python 1.20.1.dev80+g1185e270 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" />
 
@@ -15,7 +15,7 @@
 
         <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=197f51f2"></script>
+        <script src="_static/documentation_options.js?v=852d77fc"></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>
@@ -39,7 +39,7 @@
             hutch-python
           </a>
               <div class="version">
-                1.19.1.dev17+ga2b1b55
+                1.20.1.dev80+g1185e270
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

master/cache.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>cache.py &mdash; hutch-python 1.19.1.dev17+ga2b1b55 documentation</title>
+  <title>cache.py &mdash; hutch-python 1.20.1.dev80+g1185e270 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" />
 
@@ -15,7 +15,7 @@
 
         <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=197f51f2"></script>
+        <script src="_static/documentation_options.js?v=852d77fc"></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>
@@ -39,7 +39,7 @@
             hutch-python
           </a>
               <div class="version">
-                1.19.1.dev17+ga2b1b55
+                1.20.1.dev80+g1185e270
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

master/cli.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>cli.py &mdash; hutch-python 1.19.1.dev17+ga2b1b55 documentation</title>
+  <title>cli.py &mdash; hutch-python 1.20.1.dev80+g1185e270 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" />
 
@@ -15,7 +15,7 @@
 
         <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=197f51f2"></script>
+        <script src="_static/documentation_options.js?v=852d77fc"></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>
@@ -39,7 +39,7 @@
             hutch-python
           </a>
               <div class="version">
-                1.19.1.dev17+ga2b1b55
+                1.20.1.dev80+g1185e270
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

master/daq.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>DAQ &mdash; hutch-python 1.19.1.dev17+ga2b1b55 documentation</title>
+  <title>DAQ &mdash; hutch-python 1.20.1.dev80+g1185e270 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" />
 
@@ -15,7 +15,7 @@
 
         <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=197f51f2"></script>
+        <script src="_static/documentation_options.js?v=852d77fc"></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>
@@ -39,7 +39,7 @@
             hutch-python
           </a>
               <div class="version">
-                1.19.1.dev17+ga2b1b55
+                1.20.1.dev80+g1185e270
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -175,7 +175,7 @@ <h2>In a Scan<a class="headerlink" href="#in-a-scan" title="Link to this heading
 
 <span class="go"># Scan motor from 0 to 10 in 11 steps, run daq at each point</span>
 <span class="gp">In [7]: </span><span class="n">RE</span><span class="p">(</span><span class="n">scan</span><span class="p">([</span><span class="n">daq</span><span class="p">],</span> <span class="n">motor</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">11</span><span class="p">))</span>
-<span class="gh">Out[7]: </span><span class="go">(&#39;0bd8d379-c258-4617-9e09-94b6878d3e9b&#39;,)</span>
+<span class="gh">Out[7]: </span><span class="go">(&#39;2204d204-29a5-41f5-bc54-d0e42d882331&#39;,)</span>
 </pre></div>
 </div>
 </section>

master/database.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Database Objects &mdash; hutch-python 1.19.1.dev17+ga2b1b55 documentation</title>
+  <title>Database Objects &mdash; hutch-python 1.20.1.dev80+g1185e270 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" />
 
@@ -15,7 +15,7 @@
 
         <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=197f51f2"></script>
+        <script src="_static/documentation_options.js?v=852d77fc"></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>
@@ -39,7 +39,7 @@
             hutch-python
           </a>
               <div class="version">
-                1.19.1.dev17+ga2b1b55
+                1.20.1.dev80+g1185e270
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

master/debug.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Debug &mdash; hutch-python 1.19.1.dev17+ga2b1b55 documentation</title>
+  <title>Debug &mdash; hutch-python 1.20.1.dev80+g1185e270 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" />
 
@@ -15,7 +15,7 @@
 
         <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=197f51f2"></script>
+        <script src="_static/documentation_options.js?v=852d77fc"></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>
@@ -39,7 +39,7 @@
             hutch-python
           </a>
               <div class="version">
-                1.19.1.dev17+ga2b1b55
+                1.20.1.dev80+g1185e270
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

master/environment.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Environments &mdash; hutch-python 1.19.1.dev17+ga2b1b55 documentation</title>
+  <title>Environments &mdash; hutch-python 1.20.1.dev80+g1185e270 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" />
 
@@ -15,7 +15,7 @@
 
         <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=197f51f2"></script>
+        <script src="_static/documentation_options.js?v=852d77fc"></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>
@@ -39,7 +39,7 @@
             hutch-python
           </a>
               <div class="version">
-                1.19.1.dev17+ga2b1b55
+                1.20.1.dev80+g1185e270
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

master/experiment.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Experiment File &mdash; hutch-python 1.19.1.dev17+ga2b1b55 documentation</title>
+  <title>Experiment File &mdash; hutch-python 1.20.1.dev80+g1185e270 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" />
 
@@ -15,7 +15,7 @@
 
         <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=197f51f2"></script>
+        <script src="_static/documentation_options.js?v=852d77fc"></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>
@@ -39,7 +39,7 @@
             hutch-python
           </a>
               <div class="version">
-                1.19.1.dev17+ga2b1b55
+                1.20.1.dev80+g1185e270
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

master/generated/hutch_python.bug.get_current_environment.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hutch_python.bug.get_current_environment &mdash; hutch-python 1.19.1.dev17+ga2b1b55 documentation</title>
+  <title>hutch_python.bug.get_current_environment &mdash; hutch-python 1.20.1.dev80+g1185e270 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" />
 
@@ -15,7 +15,7 @@
 
         <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=197f51f2"></script>
+        <script src="../_static/documentation_options.js?v=852d77fc"></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>
@@ -39,7 +39,7 @@
             hutch-python
           </a>
               <div class="version">
-                1.19.1.dev17+ga2b1b55
+                1.20.1.dev80+g1185e270
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">

master/generated/hutch_python.bug.get_last_n_commands.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hutch_python.bug.get_last_n_commands &mdash; hutch-python 1.19.1.dev17+ga2b1b55 documentation</title>
+  <title>hutch_python.bug.get_last_n_commands &mdash; hutch-python 1.20.1.dev80+g1185e270 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" />
 
@@ -15,7 +15,7 @@
 
         <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=197f51f2"></script>
+        <script src="../_static/documentation_options.js?v=852d77fc"></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>
@@ -39,7 +39,7 @@
             hutch-python
           </a>
               <div class="version">
-                1.19.1.dev17+ga2b1b55
+                1.20.1.dev80+g1185e270
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">

master/generated/hutch_python.bug.get_text_from_editor.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hutch_python.bug.get_text_from_editor &mdash; hutch-python 1.19.1.dev17+ga2b1b55 documentation</title>
+  <title>hutch_python.bug.get_text_from_editor &mdash; hutch-python 1.20.1.dev80+g1185e270 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" />
 
@@ -15,7 +15,7 @@
 
         <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=197f51f2"></script>
+        <script src="../_static/documentation_options.js?v=852d77fc"></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>
@@ -39,7 +39,7 @@
             hutch-python
           </a>
               <div class="version">
-                1.19.1.dev17+ga2b1b55
+                1.20.1.dev80+g1185e270
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">