Deployed 53d58e8 to latest with MkDocs 1.6.1 and mike 2.1.3

EMMC-ASBL · Sep 5, 2024 · 0527482 · 0527482
1 parent 5aefddc
commit 0527482
Show file tree

Hide file tree

Showing 42 changed files with 1,619 additions and 1,572 deletions.
diff --git a/latest/CHANGELOG/index.html b/latest/CHANGELOG/index.html
@@ -952,6 +952,10 @@
 <h1 id="changelog">Changelog<a class="headerlink" href="#changelog" title="Permanent link">&para;</a></h1>
 <h2 id="unreleased-changes-2024-09-05"><a href="https://github.com/EMMC-ASBL/oteapi-core/tree/Unreleased changes">Unreleased changes</a> (2024-09-05)<a class="headerlink" href="#unreleased-changes-2024-09-05" title="Permanent link">&para;</a></h2>
 <p><a href="https://github.com/EMMC-ASBL/oteapi-core/compare/v0.7.0.dev2...Unreleased changes">Full Changelog</a></p>
+<p><strong>Fixed bugs:</strong></p>
+<ul>
+<li>pre-commit config should be updated to state <code>master</code> instead of <code>main</code> <a href="https://github.com/EMMC-ASBL/oteapi-core/issues/469">#469</a></li>
+</ul>
 <p><strong>Merged pull requests:</strong></p>
 <ul>
 <li>[Auto-generated] Update dependencies <a href="https://github.com/EMMC-ASBL/oteapi-core/pull/521">#521</a> (<a href="https://github.com/TEAM4-0">TEAM4-0</a>)</li>
@@ -961,6 +965,7 @@ <h2 id="unreleased-changes-2024-09-05"><a href="https://github.com/EMMC-ASBL/ote
 <li>[Auto-generated] Update dependencies <a href="https://github.com/EMMC-ASBL/oteapi-core/pull/506">#506</a> (<a href="https://github.com/TEAM4-0">TEAM4-0</a>)</li>
 <li>[Auto-generated] Update dependencies <a href="https://github.com/EMMC-ASBL/oteapi-core/pull/500">#500</a> (<a href="https://github.com/TEAM4-0">TEAM4-0</a>)</li>
 <li>[Auto-generated] Update dependencies <a href="https://github.com/EMMC-ASBL/oteapi-core/pull/499">#499</a> (<a href="https://github.com/TEAM4-0">TEAM4-0</a>)</li>
+<li>Update dev tools and CI/CD workflows <a href="https://github.com/EMMC-ASBL/oteapi-core/pull/497">#497</a> (<a href="https://github.com/CasperWA">CasperWA</a>)</li>
 </ul>
 <h2 id="v070dev2-2024-07-05"><a href="https://github.com/EMMC-ASBL/oteapi-core/tree/v0.7.0.dev2">v0.7.0.dev2</a> (2024-07-05)<a class="headerlink" href="#v070dev2-2024-07-05" title="Permanent link">&para;</a></h2>
 <p><a href="https://github.com/EMMC-ASBL/oteapi-core/compare/v0.7.0.dev1...v0.7.0.dev2">Full Changelog</a></p>

diff --git a/latest/all_models/index.html b/latest/all_models/index.html
diff --git a/latest/all_strategies/index.html b/latest/all_strategies/index.html
diff --git a/latest/api_reference/datacache/datacache/index.html b/latest/api_reference/datacache/datacache/index.html
diff --git a/latest/api_reference/interfaces/idownloadstrategy/index.html b/latest/api_reference/interfaces/idownloadstrategy/index.html
@@ -458,9 +458,7 @@ <h2 id="oteapi.interfaces.idownloadstrategy.IDownloadStrategy" class="doc doc-he
 
               <details class="quote">
                 <summary>Source code in <code>oteapi/interfaces/idownloadstrategy.py</code></summary>
-                <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">10</span>
-<span class="normal">11</span>
-<span class="normal">12</span>
+                <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">12</span>
 <span class="normal">13</span>
 <span class="normal">14</span>
 <span class="normal">15</span>
@@ -483,13 +481,15 @@ <h2 id="oteapi.interfaces.idownloadstrategy.IDownloadStrategy" class="doc doc-he
 <span class="normal">32</span>
 <span class="normal">33</span>
 <span class="normal">34</span>
-<span class="normal">35</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@dataclass</span>  <span class="c1"># type: ignore[misc]</span>
+<span class="normal">35</span>
+<span class="normal">36</span>
+<span class="normal">37</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@dataclass</span>  <span class="c1"># type: ignore[misc]</span>
 <span class="k">class</span> <span class="nc">IDownloadStrategy</span><span class="p">(</span><span class="n">Protocol</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Download Strategy Interface.&quot;&quot;&quot;</span>
 
-    <span class="n">download_config</span><span class="p">:</span> <span class="s2">&quot;ResourceConfig&quot;</span>
+    <span class="n">download_config</span><span class="p">:</span> <span class="n">ResourceConfig</span>
 
-    <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s2">&quot;AttrDict&quot;</span><span class="p">:</span>
+    <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AttrDict</span><span class="p">:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Execute the strategy.</span>
 
 <span class="sd">        Returns:</span>
@@ -498,7 +498,7 @@ <h2 id="oteapi.interfaces.idownloadstrategy.IDownloadStrategy" class="doc doc-he
 
 <span class="sd">        &quot;&quot;&quot;</span>
 
-    <span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s2">&quot;AttrDict&quot;</span><span class="p">:</span>
+    <span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AttrDict</span><span class="p">:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Initialize data class.</span>
 
 <span class="sd">        This method will be called through the `/initialize` endpoint of the OTE-API</span>
@@ -572,14 +572,14 @@ <h3 id="oteapi.interfaces.idownloadstrategy.IDownloadStrategy.get" class="doc do
 
             <details class="quote">
               <summary>Source code in <code>oteapi/interfaces/idownloadstrategy.py</code></summary>
-              <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">16</span>
-<span class="normal">17</span>
-<span class="normal">18</span>
+              <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">18</span>
 <span class="normal">19</span>
 <span class="normal">20</span>
 <span class="normal">21</span>
 <span class="normal">22</span>
-<span class="normal">23</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s2">&quot;AttrDict&quot;</span><span class="p">:</span>
+<span class="normal">23</span>
+<span class="normal">24</span>
+<span class="normal">25</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AttrDict</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Execute the strategy.</span>
 
 <span class="sd">    Returns:</span>
@@ -643,17 +643,17 @@ <h3 id="oteapi.interfaces.idownloadstrategy.IDownloadStrategy.initialize" class=
 
             <details class="quote">
               <summary>Source code in <code>oteapi/interfaces/idownloadstrategy.py</code></summary>
-              <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">25</span>
-<span class="normal">26</span>
-<span class="normal">27</span>
+              <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">27</span>
 <span class="normal">28</span>
 <span class="normal">29</span>
 <span class="normal">30</span>
 <span class="normal">31</span>
 <span class="normal">32</span>
 <span class="normal">33</span>
 <span class="normal">34</span>
-<span class="normal">35</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s2">&quot;AttrDict&quot;</span><span class="p">:</span>
+<span class="normal">35</span>
+<span class="normal">36</span>
+<span class="normal">37</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AttrDict</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Initialize data class.</span>
 
 <span class="sd">    This method will be called through the `/initialize` endpoint of the OTE-API</span>

diff --git a/latest/api_reference/interfaces/ifilterstrategy/index.html b/latest/api_reference/interfaces/ifilterstrategy/index.html
@@ -458,9 +458,7 @@ <h2 id="oteapi.interfaces.ifilterstrategy.IFilterStrategy" class="doc doc-headin
 
               <details class="quote">
                 <summary>Source code in <code>oteapi/interfaces/ifilterstrategy.py</code></summary>
-                <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">10</span>
-<span class="normal">11</span>
-<span class="normal">12</span>
+                <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">12</span>
 <span class="normal">13</span>
 <span class="normal">14</span>
 <span class="normal">15</span>
@@ -483,13 +481,15 @@ <h2 id="oteapi.interfaces.ifilterstrategy.IFilterStrategy" class="doc doc-headin
 <span class="normal">32</span>
 <span class="normal">33</span>
 <span class="normal">34</span>
-<span class="normal">35</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@dataclass</span>  <span class="c1"># type: ignore[misc]</span>
+<span class="normal">35</span>
+<span class="normal">36</span>
+<span class="normal">37</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@dataclass</span>  <span class="c1"># type: ignore[misc]</span>
 <span class="k">class</span> <span class="nc">IFilterStrategy</span><span class="p">(</span><span class="n">Protocol</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Filter Strategy Interface.&quot;&quot;&quot;</span>
 
-    <span class="n">filter_config</span><span class="p">:</span> <span class="s2">&quot;FilterConfig&quot;</span>
+    <span class="n">filter_config</span><span class="p">:</span> <span class="n">FilterConfig</span>
 
-    <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s2">&quot;AttrDict&quot;</span><span class="p">:</span>
+    <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AttrDict</span><span class="p">:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Execute the strategy.</span>
 
 <span class="sd">        Returns:</span>
@@ -498,7 +498,7 @@ <h2 id="oteapi.interfaces.ifilterstrategy.IFilterStrategy" class="doc doc-headin
 
 <span class="sd">        &quot;&quot;&quot;</span>
 
-    <span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s2">&quot;AttrDict&quot;</span><span class="p">:</span>
+    <span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AttrDict</span><span class="p">:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Initialize data class.</span>
 
 <span class="sd">        This method will be called through the `/initialize` endpoint of the OTE-API</span>
@@ -572,14 +572,14 @@ <h3 id="oteapi.interfaces.ifilterstrategy.IFilterStrategy.get" class="doc doc-he
 
             <details class="quote">
               <summary>Source code in <code>oteapi/interfaces/ifilterstrategy.py</code></summary>
-              <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">16</span>
-<span class="normal">17</span>
-<span class="normal">18</span>
+              <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">18</span>
 <span class="normal">19</span>
 <span class="normal">20</span>
 <span class="normal">21</span>
 <span class="normal">22</span>
-<span class="normal">23</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s2">&quot;AttrDict&quot;</span><span class="p">:</span>
+<span class="normal">23</span>
+<span class="normal">24</span>
+<span class="normal">25</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AttrDict</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Execute the strategy.</span>
 
 <span class="sd">    Returns:</span>
@@ -643,17 +643,17 @@ <h3 id="oteapi.interfaces.ifilterstrategy.IFilterStrategy.initialize" class="doc
 
             <details class="quote">
               <summary>Source code in <code>oteapi/interfaces/ifilterstrategy.py</code></summary>
-              <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">25</span>
-<span class="normal">26</span>
-<span class="normal">27</span>
+              <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">27</span>
 <span class="normal">28</span>
 <span class="normal">29</span>
 <span class="normal">30</span>
 <span class="normal">31</span>
 <span class="normal">32</span>
 <span class="normal">33</span>
 <span class="normal">34</span>
-<span class="normal">35</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s2">&quot;AttrDict&quot;</span><span class="p">:</span>
+<span class="normal">35</span>
+<span class="normal">36</span>
+<span class="normal">37</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AttrDict</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Initialize data class.</span>
 
 <span class="sd">    This method will be called through the `/initialize` endpoint of the OTE-API</span>