Automated update of main branch documentation

Author: Documentation Bot

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

dev/_modules/index.html

@@ -119,15 +119,15 @@ <h1>All modules for which code is available</h1>
             <p class="logo"><a href="../index.html">
               <img class="logo" src="../_static/img/e-logo.png" alt="Logo">
             </a></p>
-<div id="searchbox" style="display: none" role="search">
+<search id="searchbox" style="display: none" role="search">
   <h3 id="searchlabel">Quick search</h3>
     <div class="searchformwrapper">
     <form class="search" action="../search.html" method="get">
       <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
       <input type="submit" value="Go" />
     </form>
     </div>
-</div>
+</search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
         </div>
       </div>
@@ -148,7 +148,7 @@ <h3 id="searchlabel">Quick search</h3>
         &copy; Copyright 2018-2024 Enthought, Inc., Austin, TX
       </li>
       <li>
-      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 7.2.6.
+      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 8.1.3.
       </li>
     </ul>
     </div>

dev/_modules/traits_futures/asyncio/event_loop.html

@@ -95,18 +95,18 @@ <h1>Source code for traits_futures.asyncio.event_loop</h1><div class="highlight"
 <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">IEventLoop implementation wrapping an asyncio event loop.</span>
 <span class="sd">&quot;&quot;&quot;</span>
-<span class="kn">import</span> <span class="nn">asyncio</span>
-<span class="kn">import</span> <span class="nn">warnings</span>
+<span class="kn">import</span><span class="w"> </span><span class="nn">asyncio</span>
+<span class="kn">import</span><span class="w"> </span><span class="nn">warnings</span>
 
-<span class="kn">from</span> <span class="nn">traits_futures.asyncio.event_loop_helper</span> <span class="kn">import</span> <span class="n">EventLoopHelper</span>
-<span class="kn">from</span> <span class="nn">traits_futures.asyncio.pingee</span> <span class="kn">import</span> <span class="n">Pingee</span>
-<span class="kn">from</span> <span class="nn">traits_futures.i_event_loop</span> <span class="kn">import</span> <span class="n">IEventLoop</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">traits_futures.asyncio.event_loop_helper</span><span class="w"> </span><span class="kn">import</span> <span class="n">EventLoopHelper</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">traits_futures.asyncio.pingee</span><span class="w"> </span><span class="kn">import</span> <span class="n">Pingee</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">traits_futures.i_event_loop</span><span class="w"> </span><span class="kn">import</span> <span class="n">IEventLoop</span>
 
 
 <div class="viewcode-block" id="AsyncioEventLoop">
 <a class="viewcode-back" href="../../../api/traits_futures.asyncio.event_loop.html#traits_futures.asyncio.event_loop.AsyncioEventLoop">[docs]</a>
 <span class="nd">@IEventLoop</span><span class="o">.</span><span class="n">register</span>
-<span class="k">class</span> <span class="nc">AsyncioEventLoop</span><span class="p">:</span>
+<span class="k">class</span><span class="w"> </span><span class="nc">AsyncioEventLoop</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    IEventLoop implementation wrapping an asyncio event loop.</span>
 
@@ -117,7 +117,7 @@ <h1>Source code for traits_futures.asyncio.event_loop</h1><div class="highlight"
 <span class="sd">        event loop will be created and used.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
-    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">event_loop</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">event_loop</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
         <span class="n">own_event_loop</span> <span class="o">=</span> <span class="n">event_loop</span> <span class="ow">is</span> <span class="kc">None</span>
         <span class="k">if</span> <span class="n">own_event_loop</span><span class="p">:</span>
             <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
@@ -134,7 +134,7 @@ <h1>Source code for traits_futures.asyncio.event_loop</h1><div class="highlight"
 
 <div class="viewcode-block" id="AsyncioEventLoop.close">
 <a class="viewcode-back" href="../../../api/traits_futures.asyncio.event_loop.html#traits_futures.asyncio.event_loop.AsyncioEventLoop.close">[docs]</a>
-    <span class="k">def</span> <span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Free any resources allocated by this object.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
@@ -144,7 +144,7 @@ <h1>Source code for traits_futures.asyncio.event_loop</h1><div class="highlight"
 
 <div class="viewcode-block" id="AsyncioEventLoop.pingee">
 <a class="viewcode-back" href="../../../api/traits_futures.asyncio.event_loop.html#traits_futures.asyncio.event_loop.AsyncioEventLoop.pingee">[docs]</a>
-    <span class="k">def</span> <span class="nf">pingee</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">on_ping</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">pingee</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">on_ping</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Return a new pingee.</span>
 
@@ -164,7 +164,7 @@ <h1>Source code for traits_futures.asyncio.event_loop</h1><div class="highlight"
 
 <div class="viewcode-block" id="AsyncioEventLoop.helper">
 <a class="viewcode-back" href="../../../api/traits_futures.asyncio.event_loop.html#traits_futures.asyncio.event_loop.AsyncioEventLoop.helper">[docs]</a>
-    <span class="k">def</span> <span class="nf">helper</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">helper</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Return a new event loop helper.</span>
 
@@ -185,15 +185,15 @@ <h1>Source code for traits_futures.asyncio.event_loop</h1><div class="highlight"
             <p class="logo"><a href="../../../index.html">
               <img class="logo" src="../../../_static/img/e-logo.png" alt="Logo">
             </a></p>
-<div id="searchbox" style="display: none" role="search">
+<search id="searchbox" style="display: none" role="search">
   <h3 id="searchlabel">Quick search</h3>
     <div class="searchformwrapper">
     <form class="search" action="../../../search.html" method="get">
       <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
       <input type="submit" value="Go" />
     </form>
     </div>
-</div>
+</search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
         </div>
       </div>
@@ -214,7 +214,7 @@ <h3 id="searchlabel">Quick search</h3>
         &copy; Copyright 2018-2024 Enthought, Inc., Austin, TX
       </li>
       <li>
-      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 7.2.6.
+      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 8.1.3.
       </li>
     </ul>
     </div>

dev/_modules/traits_futures/asyncio/event_loop_helper.html

@@ -96,13 +96,13 @@ <h1>Source code for traits_futures.asyncio.event_loop_helper</h1><div class="hig
 <span class="sd">Test support, providing the ability to run the event loop from tests.</span>
 <span class="sd">&quot;&quot;&quot;</span>
 
-<span class="kn">from</span> <span class="nn">traits_futures.i_event_loop_helper</span> <span class="kn">import</span> <span class="n">IEventLoopHelper</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">traits_futures.i_event_loop_helper</span><span class="w"> </span><span class="kn">import</span> <span class="n">IEventLoopHelper</span>
 
 
 <div class="viewcode-block" id="EventLoopHelper">
 <a class="viewcode-back" href="../../../api/traits_futures.asyncio.event_loop_helper.html#traits_futures.asyncio.event_loop_helper.EventLoopHelper">[docs]</a>
 <span class="nd">@IEventLoopHelper</span><span class="o">.</span><span class="n">register</span>
-<span class="k">class</span> <span class="nc">EventLoopHelper</span><span class="p">:</span>
+<span class="k">class</span><span class="w"> </span><span class="nc">EventLoopHelper</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Support for running the asyncio event loop in unit tests.</span>
 
@@ -112,12 +112,12 @@ <h1>Source code for traits_futures.asyncio.event_loop_helper</h1><div class="hig
 <span class="sd">        The asyncio event loop that this object wraps.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
-    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">event_loop</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">event_loop</span><span class="p">):</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_event_loop</span> <span class="o">=</span> <span class="n">event_loop</span>
 
 <div class="viewcode-block" id="EventLoopHelper.init">
 <a class="viewcode-back" href="../../../api/traits_futures.asyncio.event_loop_helper.html#traits_futures.asyncio.event_loop_helper.EventLoopHelper.init">[docs]</a>
-    <span class="k">def</span> <span class="nf">init</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Prepare the event loop for use.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
@@ -126,7 +126,7 @@ <h1>Source code for traits_futures.asyncio.event_loop_helper</h1><div class="hig
 
 <div class="viewcode-block" id="EventLoopHelper.dispose">
 <a class="viewcode-back" href="../../../api/traits_futures.asyncio.event_loop_helper.html#traits_futures.asyncio.event_loop_helper.EventLoopHelper.dispose">[docs]</a>
-    <span class="k">def</span> <span class="nf">dispose</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">dispose</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Dispose of any resources used by this object.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
@@ -135,7 +135,7 @@ <h1>Source code for traits_futures.asyncio.event_loop_helper</h1><div class="hig
 
 <div class="viewcode-block" id="EventLoopHelper.setattr_soon">
 <a class="viewcode-back" href="../../../api/traits_futures.asyncio.event_loop_helper.html#traits_futures.asyncio.event_loop_helper.EventLoopHelper.setattr_soon">[docs]</a>
-    <span class="k">def</span> <span class="nf">setattr_soon</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">setattr_soon</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Arrange for an attribute to be set once the event loop is running.</span>
 
@@ -160,7 +160,7 @@ <h1>Source code for traits_futures.asyncio.event_loop_helper</h1><div class="hig
 
 <div class="viewcode-block" id="EventLoopHelper.run_until">
 <a class="viewcode-back" href="../../../api/traits_futures.asyncio.event_loop_helper.html#traits_futures.asyncio.event_loop_helper.EventLoopHelper.run_until">[docs]</a>
-    <span class="k">def</span> <span class="nf">run_until</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">object</span><span class="p">,</span> <span class="n">trait</span><span class="p">,</span> <span class="n">condition</span><span class="p">,</span> <span class="n">timeout</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">run_until</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">object</span><span class="p">,</span> <span class="n">trait</span><span class="p">,</span> <span class="n">condition</span><span class="p">,</span> <span class="n">timeout</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Run event loop until a given condition occurs, or timeout.</span>
 
@@ -189,11 +189,11 @@ <h1>Source code for traits_futures.asyncio.event_loop_helper</h1><div class="hig
 
         <span class="n">event_loop</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_event_loop</span>
 
-        <span class="k">def</span> <span class="nf">stop_on_timeout</span><span class="p">():</span>
+        <span class="k">def</span><span class="w"> </span><span class="nf">stop_on_timeout</span><span class="p">():</span>
             <span class="n">timed_out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
             <span class="n">event_loop</span><span class="o">.</span><span class="n">stop</span><span class="p">()</span>
 
-        <span class="k">def</span> <span class="nf">stop_if_condition</span><span class="p">(</span><span class="n">event</span><span class="p">):</span>
+        <span class="k">def</span><span class="w"> </span><span class="nf">stop_if_condition</span><span class="p">(</span><span class="n">event</span><span class="p">):</span>
             <span class="k">if</span> <span class="n">condition</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
                 <span class="n">event_loop</span><span class="o">.</span><span class="n">stop</span><span class="p">()</span>
 
@@ -229,15 +229,15 @@ <h1>Source code for traits_futures.asyncio.event_loop_helper</h1><div class="hig
             <p class="logo"><a href="../../../index.html">
               <img class="logo" src="../../../_static/img/e-logo.png" alt="Logo">
             </a></p>
-<div id="searchbox" style="display: none" role="search">
+<search id="searchbox" style="display: none" role="search">
   <h3 id="searchlabel">Quick search</h3>
     <div class="searchformwrapper">
     <form class="search" action="../../../search.html" method="get">
       <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
       <input type="submit" value="Go" />
     </form>
     </div>
-</div>
+</search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
         </div>
       </div>
@@ -258,7 +258,7 @@ <h3 id="searchlabel">Quick search</h3>
         &copy; Copyright 2018-2024 Enthought, Inc., Austin, TX
       </li>
       <li>
-      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 7.2.6.
+      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 8.1.3.
       </li>
     </ul>
     </div>