CircleCI update of docs (1087).

expyfun/.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: 1e81704de833f830253cb5d17ba5a100
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 47ca6e5faf9424b1b0872267b50eee00
 tags: 645f666f9bcd5a90fca523b33c5a78b7

expyfun/_static/basic.css

@@ -1,12 +1,5 @@
 /*
- * basic.css
- * ~~~~~~~~~
- *
  * Sphinx stylesheet -- basic theme.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 
 /* -- main layout ----------------------------------------------------------- */
@@ -115,15 +108,11 @@ img {
 /* -- search page ----------------------------------------------------------- */
 
 ul.search {
-    margin: 10px 0 0 20px;
-    padding: 0;
+    margin-top: 10px;
 }
 
 ul.search li {
-    padding: 5px 0 5px 20px;
-    background-image: url(file.png);
-    background-repeat: no-repeat;
-    background-position: 0 7px;
+    padding: 5px 0;
 }
 
 ul.search li a {

expyfun/_static/doctools.js

@@ -1,12 +1,5 @@
 /*
- * doctools.js
- * ~~~~~~~~~~~
- *
  * Base JavaScript utilities for all Sphinx HTML documentation.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 "use strict";
 

expyfun/_static/language_data.js

@@ -1,13 +1,6 @@
 /*
- * language_data.js
- * ~~~~~~~~~~~~~~~~
- *
  * This script contains the language-specific data used by searchtools.js,
  * namely the list of stopwords, stemmer, scorer and splitter.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 
 var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];

expyfun/_static/searchtools.js

@@ -1,12 +1,5 @@
 /*
- * searchtools.js
- * ~~~~~~~~~~~~~~~~
- *
  * Sphinx JavaScript utilities for the full-text search.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 "use strict";
 
@@ -20,7 +13,7 @@ if (typeof Scorer === "undefined") {
     // and returns the new score.
     /*
     score: result => {
-      const [docname, title, anchor, descr, score, filename] = result
+      const [docname, title, anchor, descr, score, filename, kind] = result
       return score
     },
     */
@@ -47,6 +40,14 @@ if (typeof Scorer === "undefined") {
   };
 }
 
+// Global search result kind enum, used by themes to style search results.
+class SearchResultKind {
+    static get index() { return  "index"; }
+    static get object() { return "object"; }
+    static get text() { return "text"; }
+    static get title() { return "title"; }
+}
+
 const _removeChildren = (element) => {
   while (element && element.lastChild) element.removeChild(element.lastChild);
 };
@@ -64,9 +65,13 @@ const _displayItem = (item, searchTerms, highlightTerms) => {
   const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
   const contentRoot = document.documentElement.dataset.content_root;
 
-  const [docName, title, anchor, descr, score, _filename] = item;
+  const [docName, title, anchor, descr, score, _filename, kind] = item;
 
   let listItem = document.createElement("li");
+  // Add a class representing the item's type:
+  // can be used by a theme's CSS selector for styling
+  // See SearchResultKind for the class names.
+  listItem.classList.add(`kind-${kind}`);
   let requestUrl;
   let linkUrl;
   if (docBuilder === "dirhtml") {
@@ -115,8 +120,10 @@ const _finishSearch = (resultCount) => {
       "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories."
     );
   else
-    Search.status.innerText = _(
-      "Search finished, found ${resultCount} page(s) matching the search query."
+    Search.status.innerText = Documentation.ngettext(
+      "Search finished, found one page matching the search query.",
+      "Search finished, found ${resultCount} pages matching the search query.",
+      resultCount,
     ).replace('${resultCount}', resultCount);
 };
 const _displayNextItem = (
@@ -138,7 +145,7 @@ const _displayNextItem = (
   else _finishSearch(resultCount);
 };
 // Helper function used by query() to order search results.
-// Each input is an array of [docname, title, anchor, descr, score, filename].
+// Each input is an array of [docname, title, anchor, descr, score, filename, kind].
 // Order the results by score (in opposite order of appearance, since the
 // `_displayNextItem` function uses pop() to retrieve items) and then alphabetically.
 const _orderResultsByScoreThenName = (a, b) => {
@@ -248,6 +255,7 @@ const Search = {
     searchSummary.classList.add("search-summary");
     searchSummary.innerText = "";
     const searchList = document.createElement("ul");
+    searchList.setAttribute("role", "list");
     searchList.classList.add("search");
 
     const out = document.getElementById("search-results");
@@ -318,7 +326,7 @@ const Search = {
     const indexEntries = Search._index.indexentries;
 
     // Collect multiple result groups to be sorted separately and then ordered.
-    // Each is an array of [docname, title, anchor, descr, score, filename].
+    // Each is an array of [docname, title, anchor, descr, score, filename, kind].
     const normalResults = [];
     const nonMainIndexResults = [];
 
@@ -337,6 +345,7 @@ const Search = {
             null,
             score + boost,
             filenames[file],
+            SearchResultKind.title,
           ]);
         }
       }
@@ -354,6 +363,7 @@ const Search = {
             null,
             score,
             filenames[file],
+            SearchResultKind.index,
           ];
           if (isMain) {
             normalResults.push(result);
@@ -475,6 +485,7 @@ const Search = {
         descr,
         score,
         filenames[match[0]],
+        SearchResultKind.object,
       ]);
     };
     Object.keys(objects).forEach((prefix) =>
@@ -585,6 +596,7 @@ const Search = {
         null,
         score,
         filenames[file],
+        SearchResultKind.text,
       ]);
     }
     return results;

expyfun/auto_examples/analysis/analysis_demo.html

@@ -40,7 +40,7 @@
   <script src="../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
     <script src="../../_static/documentation_options.js?v=8a32eaf7"></script>
-    <script src="../../_static/doctools.js?v=9a2dae69"></script>
+    <script src="../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'auto_examples/analysis/analysis_demo';</script>
     <link rel="icon" href="../../_static/favicon.ico"/>
@@ -508,7 +508,7 @@
 <a href="https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.show.html#matplotlib.pyplot.show" title="matplotlib.pyplot.show" class="sphx-glr-backref-module-matplotlib-pyplot sphx-glr-backref-type-py-function"><span class="n">plt</span><span class="o">.</span><span class="n">show</span></a><span class="p">()</span>
 </pre></div>
 </div>
-<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 0.586 seconds)</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 0.582 seconds)</p>
 <div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-analysis-analysis-demo-py">
 <div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
 <p><a class="reference download internal" download="" href="../../_downloads/9414b40a18391a55ed6e0f7afb3fe739/analysis_demo.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">analysis_demo.ipynb</span></code></a></p>
@@ -581,7 +581,7 @@
 
   <p class="copyright">
 
-      © Copyright 2013-2024, expyfun developers. Last updated on 2024-10-08.
+      © Copyright 2013-2024, expyfun developers. Last updated on 2024-10-21.
       <br/>
 
   </p>

expyfun/auto_examples/analysis/index.html

@@ -40,7 +40,7 @@
   <script src="../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
     <script src="../../_static/documentation_options.js?v=8a32eaf7"></script>
-    <script src="../../_static/doctools.js?v=9a2dae69"></script>
+    <script src="../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'auto_examples/analysis/index';</script>
     <link rel="icon" href="../../_static/favicon.ico"/>
@@ -468,7 +468,7 @@
 
   <p class="copyright">
 
-      © Copyright 2013-2024, expyfun developers. Last updated on 2024-10-08.
+      © Copyright 2013-2024, expyfun developers. Last updated on 2024-10-21.
       <br/>
 
   </p>

expyfun/auto_examples/analysis/parse_demo.html

@@ -40,7 +40,7 @@
   <script src="../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
     <script src="../../_static/documentation_options.js?v=8a32eaf7"></script>
-    <script src="../../_static/doctools.js?v=9a2dae69"></script>
+    <script src="../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'auto_examples/analysis/parse_demo';</script>
     <link rel="icon" href="../../_static/favicon.ico"/>
@@ -512,7 +512,7 @@
 
   <p class="copyright">
 
-      © Copyright 2013-2024, expyfun developers. Last updated on 2024-10-08.
+      © Copyright 2013-2024, expyfun developers. Last updated on 2024-10-21.
       <br/>
 
   </p>

expyfun/auto_examples/analysis/sg_execution_times.html

@@ -40,7 +40,7 @@
   <script src="../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
     <script src="../../_static/documentation_options.js?v=8a32eaf7"></script>
-    <script src="../../_static/doctools.js?v=9a2dae69"></script>
+    <script src="../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'auto_examples/analysis/sg_execution_times';</script>
     <link rel="icon" href="../../_static/favicon.ico"/>
@@ -345,7 +345,7 @@
 
   <section id="computation-times">
 <span id="sphx-glr-auto-examples-analysis-sg-execution-times"></span><h1>Computation times<a class="headerlink" href="#computation-times" title="Link to this heading">#</a></h1>
-<p><strong>00:00.588</strong> total execution time for 2 files <strong>from auto_examples/analysis</strong>:</p>
+<p><strong>00:00.584</strong> total execution time for 2 files <strong>from auto_examples/analysis</strong>:</p>
 <div class="docutils container">
 <style scoped>
 <link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/5.3.0/css/bootstrap.min.css" rel="stylesheet" />
@@ -367,7 +367,7 @@
 </thead>
 <tbody>
 <tr class="row-even"><td><p><a class="reference internal" href="analysis_demo.html#sphx-glr-auto-examples-analysis-analysis-demo-py"><span class="std std-ref">Analysis demo</span></a> (<code class="docutils literal notranslate"><span class="pre">analysis_demo.py</span></code>)</p></td>
-<td><p>00:00.586</p></td>
+<td><p>00:00.582</p></td>
 <td><p>0.0</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="parse_demo.html#sphx-glr-auto-examples-analysis-parse-demo-py"><span class="std std-ref">Parsing demo</span></a> (<code class="docutils literal notranslate"><span class="pre">parse_demo.py</span></code>)</p></td>
@@ -420,7 +420,7 @@
 
   <p class="copyright">
 
-      © Copyright 2013-2024, expyfun developers. Last updated on 2024-10-08.
+      © Copyright 2013-2024, expyfun developers. Last updated on 2024-10-21.
       <br/>
 
   </p>

expyfun/auto_examples/basic_experiment.html

@@ -40,7 +40,7 @@
   <script src="../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
     <script src="../_static/documentation_options.js?v=8a32eaf7"></script>
-    <script src="../_static/doctools.js?v=9a2dae69"></script>
+    <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'auto_examples/basic_experiment';</script>
     <link rel="icon" href="../_static/favicon.ico"/>
@@ -407,33 +407,33 @@
 <p>This example demonstrates an (almost) minimum working example of the
 ExperimentController class.</p>
 <img src="../_images/sphx_glr_basic_experiment_001.png" srcset="../_images/sphx_glr_basic_experiment_001.png" alt="basic experiment" class = "sphx-glr-single-img"/><div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>exp_name: testExp
-date: 2024-10-08 13_42_39.379831
+date: 2024-10-21 23_59_53.263499
 file: /home/circleci/project/examples/basic_experiment.py
 participant: foo
 session: 001
-2024-10-08 13:42:39,380 - INFO    - Expyfun: Using version 2.0.0.dev0 (requested dev)
-2024-10-08 13:42:39,455 - INFO    - Expyfun: Setting up sound card using pyglet backend with 2 playback channels
-2024-10-08 13:42:39,662 - WARNING - Expyfun: Mismatch between reported stim sample rate (24414) and device sample rate (44100.0). Experiment Controller will resample for you, but this takes a non-trivial amount of processing time and may compromise your experimental timing and/or cause artifacts.
-2024-10-08 13:42:39,662 - INFO    - Expyfun: Setting up screen
-2024-10-08 13:42:39,814 - EXP     - Expyfun: Set screen visibility True
-2024-10-08 13:42:39,868 - INFO    - Initialized [1400  900] window on screen XlibScreen(display=&lt;pyglet.canvas.xlib.XlibDisplay object at 0x7f392c363f10&gt;, x=0, y=0, width=1400, height=900, xinerama=0) with DPI 69.73
-2024-10-08 13:42:39,868 - INFO    - Expyfun: Initializing dummy triggering mode
-2024-10-08 13:42:39,870 - INFO    - Expyfun: Initialization complete
-2024-10-08 13:42:39,870 - EXP     - Expyfun: Participant: foo
-2024-10-08 13:42:39,870 - EXP     - Expyfun: Session: 001
-2024-10-08 13:42:40,044 - WARNING - Expyfun: Resampling 1.0 seconds of audio
-2024-10-08 13:42:40,171 - EXP     - Expyfun: Loading 88200 samples to buffer
-2024-10-08 13:42:40,278 - EXP     - Expyfun: Stamp trial ID to ec_id  : tone
-2024-10-08 13:42:40,279 - EXP     - Expyfun: Stamp trial ID to ttl_id : [0, 0]
-2024-10-08 13:42:40,279 - EXP     - Stamping TTL triggers: [4 4]
-2024-10-08 13:42:40,320 - EXP     - Expyfun: Starting stimuli: flipping screen and playing audio
-2024-10-08 13:42:40,322 - EXP     - Stamping TTL triggers: [1]
-2024-10-08 13:42:40,332 - WARNING - ec.trial_ok called before stimulus had stopped
-2024-10-08 13:42:40,332 - EXP     - Expyfun: Trial OK
+2024-10-21 23:59:53,263 - INFO    - Expyfun: Using version 2.0.0.dev0 (requested dev)
+2024-10-21 23:59:53,347 - INFO    - Expyfun: Setting up sound card using pyglet backend with 2 playback channels
+2024-10-21 23:59:53,567 - WARNING - Expyfun: Mismatch between reported stim sample rate (24414) and device sample rate (44100.0). Experiment Controller will resample for you, but this takes a non-trivial amount of processing time and may compromise your experimental timing and/or cause artifacts.
+2024-10-21 23:59:53,568 - INFO    - Expyfun: Setting up screen
+2024-10-21 23:59:53,724 - EXP     - Expyfun: Set screen visibility True
+2024-10-21 23:59:53,777 - INFO    - Initialized [1400  900] window on screen XlibScreen(display=&lt;pyglet.canvas.xlib.XlibDisplay object at 0x7f07a6a599c0&gt;, x=0, y=0, width=1400, height=900, xinerama=0) with DPI 69.73
+2024-10-21 23:59:53,777 - INFO    - Expyfun: Initializing dummy triggering mode
+2024-10-21 23:59:53,779 - INFO    - Expyfun: Initialization complete
+2024-10-21 23:59:53,779 - EXP     - Expyfun: Participant: foo
+2024-10-21 23:59:53,779 - EXP     - Expyfun: Session: 001
+2024-10-21 23:59:53,945 - WARNING - Expyfun: Resampling 1.0 seconds of audio
+2024-10-21 23:59:54,078 - EXP     - Expyfun: Loading 88200 samples to buffer
+2024-10-21 23:59:54,187 - EXP     - Expyfun: Stamp trial ID to ec_id  : tone
+2024-10-21 23:59:54,187 - EXP     - Expyfun: Stamp trial ID to ttl_id : [0, 0]
+2024-10-21 23:59:54,187 - EXP     - Stamping TTL triggers: [4 4]
+2024-10-21 23:59:54,228 - EXP     - Expyfun: Starting stimuli: flipping screen and playing audio
+2024-10-21 23:59:54,230 - EXP     - Stamping TTL triggers: [1]
+2024-10-21 23:59:54,241 - WARNING - ec.trial_ok called before stimulus had stopped
+2024-10-21 23:59:54,241 - EXP     - Expyfun: Trial OK
 Presses:
 []
-2024-10-08 13:42:40,332 - INFO    - Expyfun: Exiting
-2024-10-08 13:42:40,338 - EXP     - Expyfun: Audio stopped and reset.
+2024-10-21 23:59:54,241 - INFO    - Expyfun: Exiting
+2024-10-21 23:59:54,247 - EXP     - Expyfun: Audio stopped and reset.
 </pre></div>
 </div>
 <div class="line-block">
@@ -476,7 +476,7 @@
 <span class="n">analyze</span><span class="o">.</span><span class="n">plot_screen</span><span class="p">(</span><a href="https://numpy.org/devdocs/reference/generated/numpy.ndarray.html#numpy.ndarray" title="numpy.ndarray" class="sphx-glr-backref-module-numpy sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">screenshot</span></a><span class="p">)</span>
 </pre></div>
 </div>
-<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 1.048 seconds)</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 1.072 seconds)</p>
 <div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-basic-experiment-py">
 <div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
 <p><a class="reference download internal" download="" href="../_downloads/5f9845cfb974c748f5e4c5b52de86adf/basic_experiment.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">basic_experiment.ipynb</span></code></a></p>
@@ -549,7 +549,7 @@
 
   <p class="copyright">
 
-      © Copyright 2013-2024, expyfun developers. Last updated on 2024-10-08.
+      © Copyright 2013-2024, expyfun developers. Last updated on 2024-10-21.
       <br/>
 
   </p>