Automated update of main branch documentation

Author: Documentation Bot

_modules/envisage/application.html

@@ -81,7 +81,7 @@
           <div class="body" id="spc-section-body" role="main">
 
   <h1>Source code for envisage.application_event</h1><div class="highlight"><pre>
-<span></span><span class="c1"># (C) Copyright 2007-2024 Enthought, Inc., Austin, TX</span>
+<span></span><span class="c1"># (C) Copyright 2007-2025 Enthought, Inc., Austin, TX</span>
 <span class="c1"># All rights reserved.</span>
 <span class="c1">#</span>
 <span class="c1"># This software is provided without warranty under the terms of the BSD</span>
@@ -94,10 +94,10 @@ <h1>Source code for envisage.application_event</h1><div class="highlight"><pre>
 
 
 <span class="c1"># Enthought library imports.</span>
-<span class="kn">from</span> <span class="nn">traits.api</span> <span class="kn">import</span> <span class="n">Instance</span><span class="p">,</span> <span class="n">Vetoable</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">traits.api</span><span class="w"> </span><span class="kn">import</span> <span class="n">Instance</span><span class="p">,</span> <span class="n">Vetoable</span>
 
 
-<div class="viewcode-block" id="ApplicationEvent"><a class="viewcode-back" href="../../api/envisage.application_event.html#envisage.application_event.ApplicationEvent">[docs]</a><span class="k">class</span> <span class="nc">ApplicationEvent</span><span class="p">(</span><span class="n">Vetoable</span><span class="p">):</span>
+<div class="viewcode-block" id="ApplicationEvent"><a class="viewcode-back" href="../../api/envisage.application_event.html#envisage.application_event.ApplicationEvent">[docs]</a><span class="k">class</span><span class="w"> </span><span class="nc">ApplicationEvent</span><span class="p">(</span><span class="n">Vetoable</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;An application event.&quot;&quot;&quot;</span>
 
     <span class="c1"># The application that the event is for.</span>
@@ -138,10 +138,10 @@ <h3 id="searchlabel">Quick search</h3>
     <div class="row-fluid">
     <ul class="inline pull-left">
       <li>
-        &copy; Copyright 2007-2024, Enthought
+        &copy; Copyright 2007-2025, Enthought
       </li>
       <li>
-      Last updated on Sep 06, 2024.
+      Last updated on Apr 25, 2025.
       </li>
       <li>
       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 6.1.3.

_modules/envisage/application_event.html

@@ -81,7 +81,7 @@
           <div class="body" id="spc-section-body" role="main">
 
   <h1>Source code for envisage.core_plugin</h1><div class="highlight"><pre>
-<span></span><span class="c1"># (C) Copyright 2007-2024 Enthought, Inc., Austin, TX</span>
+<span></span><span class="c1"># (C) Copyright 2007-2025 Enthought, Inc., Austin, TX</span>
 <span class="c1"># All rights reserved.</span>
 <span class="c1">#</span>
 <span class="c1"># This software is provided without warranty under the terms of the BSD</span>
@@ -92,17 +92,17 @@ <h1>Source code for envisage.core_plugin</h1><div class="highlight"><pre>
 <span class="c1"># Thanks for using Enthought open source!</span>
 <span class="sd">&quot;&quot;&quot; The Envisage core plugin. &quot;&quot;&quot;</span>
 
-<span class="kn">from</span> <span class="nn">contextlib</span> <span class="kn">import</span> <span class="n">closing</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">contextlib</span><span class="w"> </span><span class="kn">import</span> <span class="n">closing</span>
 
-<span class="kn">from</span> <span class="nn">traits.api</span> <span class="kn">import</span> <span class="n">List</span><span class="p">,</span> <span class="n">on_trait_change</span><span class="p">,</span> <span class="n">Str</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">traits.api</span><span class="w"> </span><span class="kn">import</span> <span class="n">List</span><span class="p">,</span> <span class="n">on_trait_change</span><span class="p">,</span> <span class="n">Str</span>
 
 <span class="c1"># Enthought library imports.</span>
-<span class="kn">from</span> <span class="nn">envisage.extension_point</span> <span class="kn">import</span> <span class="n">ExtensionPoint</span>
-<span class="kn">from</span> <span class="nn">envisage.plugin</span> <span class="kn">import</span> <span class="n">Plugin</span>
-<span class="kn">from</span> <span class="nn">envisage.service_offer</span> <span class="kn">import</span> <span class="n">ServiceOffer</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">envisage.extension_point</span><span class="w"> </span><span class="kn">import</span> <span class="n">ExtensionPoint</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">envisage.plugin</span><span class="w"> </span><span class="kn">import</span> <span class="n">Plugin</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">envisage.service_offer</span><span class="w"> </span><span class="kn">import</span> <span class="n">ServiceOffer</span>
 
 
-<div class="viewcode-block" id="CorePlugin"><a class="viewcode-back" href="../../api/envisage.core_plugin.html#envisage.core_plugin.CorePlugin">[docs]</a><span class="k">class</span> <span class="nc">CorePlugin</span><span class="p">(</span><span class="n">Plugin</span><span class="p">):</span>
+<div class="viewcode-block" id="CorePlugin"><a class="viewcode-back" href="../../api/envisage.core_plugin.html#envisage.core_plugin.CorePlugin">[docs]</a><span class="k">class</span><span class="w"> </span><span class="nc">CorePlugin</span><span class="p">(</span><span class="n">Plugin</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;The Envisage core plugin.</span>
 
 <span class="sd">    The core plugin offers facilities that are generally useful when building</span>
@@ -165,7 +165,7 @@ <h1>Source code for envisage.core_plugin</h1><div class="highlight"><pre>
     <span class="p">)</span>
 
     <span class="nd">@on_trait_change</span><span class="p">(</span><span class="s2">&quot;preferences_items&quot;</span><span class="p">)</span>
-    <span class="k">def</span> <span class="nf">_update_preferences</span><span class="p">(</span><span class="bp">self</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">_update_preferences</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">event</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;React to new preferencess being *added*.</span>
 
 <span class="sd">        Note that we don&#39;t currently do anything if preferences are *removed*.</span>
@@ -198,7 +198,7 @@ <h1>Source code for envisage.core_plugin</h1><div class="highlight"><pre>
     <span class="p">)</span>
 
     <span class="nd">@on_trait_change</span><span class="p">(</span><span class="s2">&quot;service_offers_items&quot;</span><span class="p">)</span>
-    <span class="k">def</span> <span class="nf">_register_new_services</span><span class="p">(</span><span class="bp">self</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">_register_new_services</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">event</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;React to new service offers being *added*.</span>
 
 <span class="sd">        Note that we don&#39;t currently do anything if services are *removed* as</span>
@@ -217,7 +217,7 @@ <h1>Source code for envisage.core_plugin</h1><div class="highlight"><pre>
     <span class="c1"># &#39;IPlugin&#39; interface.</span>
     <span class="c1">###########################################################################</span>
 
-<div class="viewcode-block" id="CorePlugin.start"><a class="viewcode-back" href="../../api/envisage.core_plugin.html#envisage.core_plugin.CorePlugin.start">[docs]</a>    <span class="k">def</span> <span class="nf">start</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+<div class="viewcode-block" id="CorePlugin.start"><a class="viewcode-back" href="../../api/envisage.core_plugin.html#envisage.core_plugin.CorePlugin.start">[docs]</a>    <span class="k">def</span><span class="w"> </span><span class="nf">start</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Start the plugin.&quot;&quot;&quot;</span>
         <span class="c1"># Load all contributed preferences files into the application&#39;s root</span>
         <span class="c1"># preferences node.</span>
@@ -234,11 +234,11 @@ <h1>Source code for envisage.core_plugin</h1><div class="highlight"><pre>
     <span class="c1"># Private interface.</span>
     <span class="c1">###########################################################################</span>
 
-    <span class="k">def</span> <span class="nf">_load_preferences</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">preferences</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">_load_preferences</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">preferences</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Load all contributed preferences into a preferences node.&quot;&quot;&quot;</span>
 
         <span class="c1"># Enthought library imports.</span>
-        <span class="kn">from</span> <span class="nn">envisage.resource.api</span> <span class="kn">import</span> <span class="n">ResourceManager</span>
+        <span class="kn">from</span><span class="w"> </span><span class="nn">envisage.resource.api</span><span class="w"> </span><span class="kn">import</span> <span class="n">ResourceManager</span>
 
         <span class="c1"># We add the plugin preferences to the default scope. The default scope</span>
         <span class="c1"># is a transient scope which means that (quite nicely ;^) we never</span>
@@ -253,12 +253,12 @@ <h1>Source code for envisage.core_plugin</h1><div class="highlight"><pre>
             <span class="k">with</span> <span class="n">closing</span><span class="p">(</span><span class="n">resource_manager</span><span class="o">.</span><span class="n">file</span><span class="p">(</span><span class="n">resource_name</span><span class="p">))</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
                 <span class="n">default</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">f</span><span class="p">)</span>
 
-    <span class="k">def</span> <span class="nf">_register_service_offers</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_offers</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">_register_service_offers</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_offers</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Register a list of service offers.&quot;&quot;&quot;</span>
 
         <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_register_service_offer</span><span class="p">,</span> <span class="n">service_offers</span><span class="p">))</span>
 
-    <span class="k">def</span> <span class="nf">_register_service_offer</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_offer</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">_register_service_offer</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_offer</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Register a service offer.&quot;&quot;&quot;</span>
 
         <span class="n">service_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">application</span><span class="o">.</span><span class="n">register_service</span><span class="p">(</span>
@@ -304,10 +304,10 @@ <h3 id="searchlabel">Quick search</h3>
     <div class="row-fluid">
     <ul class="inline pull-left">
       <li>
-        &copy; Copyright 2007-2024, Enthought
+        &copy; Copyright 2007-2025, Enthought
       </li>
       <li>
-      Last updated on Sep 06, 2024.
+      Last updated on Apr 25, 2025.
       </li>
       <li>
       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 6.1.3.