GitHub Actions build openturns/otwrapy 12032229448

openturns · Nov 26, 2024 · 1819e39 · 1819e39
1 parent a80f81f
commit 1819e39
Show file tree

Hide file tree

Showing 22 changed files with 331 additions and 322 deletions.
diff --git a/otwrapy/master/_generated/otwrapy.Debug.html b/otwrapy/master/_generated/otwrapy.Debug.html
@@ -7,9 +7,10 @@
 
     <title>otwrapy.Debug &#8212; otwrapy  documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=649a27d8" />
-    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=4dced5a3" />
+    <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=686e5160" />
+    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=712fa57f" />
     <script src="../_static/documentation_options.js?v=5929fcd5"></script>
-    <script src="../_static/doctools.js?v=888ff710"></script>
+    <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="../_static/Icon.ico"/>
     <link rel="index" title="Index" href="../genindex.html" />
@@ -64,14 +65,6 @@ <h1>otwrapy.Debug<a class="headerlink" href="#otwrapy-debug" title="Link to this
 </dl>
 </dd>
 </dl>
-<p class="rubric">Examples</p>
-<p>To catch exceptions raised inside a function and log them to a file :</p>
-<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">otwrapy</span> <span class="k">as</span> <span class="nn">otw</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="nd">@otw</span><span class="o">.</span><span class="n">Debug</span><span class="p">(</span><span class="s1">&#39;func.log&#39;</span><span class="p">)</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="k">def</span> <span class="nf">func</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
-<span class="gp">&gt;&gt;&gt; </span>    <span class="k">pass</span>
-</pre></div>
-</div>
 <p class="rubric">Methods</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>
@@ -80,6 +73,14 @@ <h1>otwrapy.Debug<a class="headerlink" href="#otwrapy-debug" title="Link to this
 </tr>
 </tbody>
 </table>
+<p class="rubric">Examples</p>
+<p>To catch exceptions raised inside a function and log them to a file :</p>
+<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">otwrapy</span> <span class="k">as</span> <span class="nn">otw</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="nd">@otw</span><span class="o">.</span><span class="n">Debug</span><span class="p">(</span><span class="s1">&#39;func.log&#39;</span><span class="p">)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="k">def</span> <span class="nf">func</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+<span class="gp">&gt;&gt;&gt; </span>    <span class="k">pass</span>
+</pre></div>
+</div>
 <dl class="py method">
 <dt class="sig sig-object py" id="otwrapy.Debug.__init__">
 <span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">logger</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">loglevel</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#otwrapy.Debug.__init__" title="Link to this definition">¶</a></dt>
@@ -102,7 +103,7 @@ <h1>otwrapy.Debug<a class="headerlink" href="#otwrapy-debug" title="Link to this
 
         </div>
       </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
         <div class="sphinxsidebarwrapper">
 <p class="logo">
   <a href="../index.html">
@@ -164,15 +165,15 @@ <h3>Related Topics</h3>
   </ul></li>
 </ul>
 </div>
-<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>
 
 
@@ -190,8 +191,8 @@ <h3 id="searchlabel">Quick search</h3>
       &#169;2015-2024 Phimeca.
 
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.2.6</a>
-      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
 
       |
       <a href="../_sources/_generated/otwrapy.Debug.rst.txt"
@@ -200,7 +201,7 @@ <h3 id="searchlabel">Quick search</h3>
 
 
     <a href="https://github.com/openturns/otwrapy" class="github">
-        <img style="position: absolute; top: 0; right: 0; border: 0;" src="https://github.blog/wp-content/uploads/2008/12/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"  class="github"/>
+        <img src="../_static/github-banner.svg" alt="Fork me on GitHub" class="github"/>
     </a>
 
 

diff --git a/otwrapy/master/_generated/otwrapy.FunctionDecorator.html b/otwrapy/master/_generated/otwrapy.FunctionDecorator.html
@@ -7,9 +7,10 @@
 
     <title>otwrapy.FunctionDecorator &#8212; otwrapy  documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=649a27d8" />
-    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=4dced5a3" />
+    <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=686e5160" />
+    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=712fa57f" />
     <script src="../_static/documentation_options.js?v=5929fcd5"></script>
-    <script src="../_static/doctools.js?v=888ff710"></script>
+    <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="../_static/Icon.ico"/>
     <link rel="index" title="Index" href="../genindex.html" />
@@ -48,6 +49,14 @@ <h1>otwrapy.FunctionDecorator<a class="headerlink" href="#otwrapy-functiondecora
 </dl>
 </dd>
 </dl>
+<p class="rubric">Methods</p>
+<table class="autosummary longtable docutils align-default">
+<tbody>
+<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">__call__</span></code>(wrapper)</p></td>
+<td><p>Call self as a function.</p></td>
+</tr>
+</tbody>
+</table>
 <p class="rubric">Notes</p>
 <p>I wanted this decorator to work also with Wrapper class, but it only works
 with ParallelWrapper for the moment. The problem is that, apparently,
@@ -72,14 +81,6 @@ <h1>otwrapy.FunctionDecorator<a class="headerlink" href="#otwrapy-functiondecora
 be parallelized afterwards. Only use it if you don’t plan to parallelize
 your wrapper or if the wrapper itself is parallelized already. However, if
 you plan to use <a class="reference internal" href="otwrapy.Parallelizer.html#otwrapy.Parallelizer" title="otwrapy.Parallelizer"><code class="xref py py-class docutils literal notranslate"><span class="pre">Parallelizer</span></code></a>, there is no need to use this decorator !</p>
-<p class="rubric">Methods</p>
-<table class="autosummary longtable docutils align-default">
-<tbody>
-<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">__call__</span></code>(wrapper)</p></td>
-<td><p>Call self as a function.</p></td>
-</tr>
-</tbody>
-</table>
 <dl class="py method">
 <dt class="sig sig-object py" id="otwrapy.FunctionDecorator.__init__">
 <span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enableCache</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#otwrapy.FunctionDecorator.__init__" title="Link to this definition">¶</a></dt>
@@ -102,7 +103,7 @@ <h1>otwrapy.FunctionDecorator<a class="headerlink" href="#otwrapy-functiondecora
 
         </div>
       </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
         <div class="sphinxsidebarwrapper">
 <p class="logo">
   <a href="../index.html">
@@ -164,15 +165,15 @@ <h3>Related Topics</h3>
   </ul></li>
 </ul>
 </div>
-<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>
 
 
@@ -190,8 +191,8 @@ <h3 id="searchlabel">Quick search</h3>
       &#169;2015-2024 Phimeca.
 
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.2.6</a>
-      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
 
       |
       <a href="../_sources/_generated/otwrapy.FunctionDecorator.rst.txt"
@@ -200,7 +201,7 @@ <h3 id="searchlabel">Quick search</h3>
 
 
     <a href="https://github.com/openturns/otwrapy" class="github">
-        <img style="position: absolute; top: 0; right: 0; border: 0;" src="https://github.blog/wp-content/uploads/2008/12/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"  class="github"/>
+        <img src="../_static/github-banner.svg" alt="Fork me on GitHub" class="github"/>
     </a>
 
 

diff --git a/otwrapy/master/_generated/otwrapy.Parallelizer.html b/otwrapy/master/_generated/otwrapy.Parallelizer.html
@@ -7,9 +7,10 @@
 
     <title>otwrapy.Parallelizer &#8212; otwrapy  documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=649a27d8" />
-    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=4dced5a3" />
+    <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=686e5160" />
+    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=712fa57f" />
     <script src="../_static/documentation_options.js?v=5929fcd5"></script>
-    <script src="../_static/doctools.js?v=888ff710"></script>
+    <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="../_static/Icon.ico"/>
     <link rel="index" title="Index" href="../genindex.html" />
@@ -89,7 +90,7 @@ <h1>otwrapy.Parallelizer<a class="headerlink" href="#otwrapy-parallelizer" title
 
         </div>
       </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
         <div class="sphinxsidebarwrapper">
 <p class="logo">
   <a href="../index.html">
@@ -151,15 +152,15 @@ <h3>Related Topics</h3>
   </ul></li>
 </ul>
 </div>
-<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>
 
 
@@ -177,8 +178,8 @@ <h3 id="searchlabel">Quick search</h3>
       &#169;2015-2024 Phimeca.
 
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.2.6</a>
-      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
 
       |
       <a href="../_sources/_generated/otwrapy.Parallelizer.rst.txt"
@@ -187,7 +188,7 @@ <h3 id="searchlabel">Quick search</h3>
 
 
     <a href="https://github.com/openturns/otwrapy" class="github">
-        <img style="position: absolute; top: 0; right: 0; border: 0;" src="https://github.blog/wp-content/uploads/2008/12/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"  class="github"/>
+        <img src="../_static/github-banner.svg" alt="Fork me on GitHub" class="github"/>
     </a>
 
 

diff --git a/otwrapy/master/_generated/otwrapy.TempWorkDir.html b/otwrapy/master/_generated/otwrapy.TempWorkDir.html
@@ -7,9 +7,10 @@
 
     <title>otwrapy.TempWorkDir &#8212; otwrapy  documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=649a27d8" />
-    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=4dced5a3" />
+    <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=686e5160" />
+    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=712fa57f" />
     <script src="../_static/documentation_options.js?v=5929fcd5"></script>
-    <script src="../_static/doctools.js?v=888ff710"></script>
+    <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="../_static/Icon.ico"/>
     <link rel="index" title="Index" href="../genindex.html" />
@@ -112,7 +113,7 @@ <h1>otwrapy.TempWorkDir<a class="headerlink" href="#otwrapy-tempworkdir" title="
 
         </div>
       </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
         <div class="sphinxsidebarwrapper">
 <p class="logo">
   <a href="../index.html">
@@ -174,15 +175,15 @@ <h3>Related Topics</h3>
   </ul></li>
 </ul>
 </div>
-<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>
 
 
@@ -200,8 +201,8 @@ <h3 id="searchlabel">Quick search</h3>
       &#169;2015-2024 Phimeca.
 
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.2.6</a>
-      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
 
       |
       <a href="../_sources/_generated/otwrapy.TempWorkDir.rst.txt"
@@ -210,7 +211,7 @@ <h3 id="searchlabel">Quick search</h3>
 
 
     <a href="https://github.com/openturns/otwrapy" class="github">
-        <img style="position: absolute; top: 0; right: 0; border: 0;" src="https://github.blog/wp-content/uploads/2008/12/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"  class="github"/>
+        <img src="../_static/github-banner.svg" alt="Fork me on GitHub" class="github"/>
     </a>
 
 

diff --git a/otwrapy/master/_generated/otwrapy.create_logger.html b/otwrapy/master/_generated/otwrapy.create_logger.html
@@ -7,9 +7,10 @@
 
     <title>otwrapy.create_logger &#8212; otwrapy  documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=649a27d8" />
-    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=4dced5a3" />
+    <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=686e5160" />
+    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=712fa57f" />
     <script src="../_static/documentation_options.js?v=5929fcd5"></script>
-    <script src="../_static/doctools.js?v=888ff710"></script>
+    <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="../_static/Icon.ico"/>
     <link rel="index" title="Index" href="../genindex.html" />
@@ -58,7 +59,7 @@ <h1>otwrapy.create_logger<a class="headerlink" href="#otwrapy-create-logger" tit
 
         </div>
       </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
         <div class="sphinxsidebarwrapper">
 <p class="logo">
   <a href="../index.html">
@@ -119,15 +120,15 @@ <h3>Related Topics</h3>
   </ul></li>
 </ul>
 </div>
-<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>
 
 
@@ -145,8 +146,8 @@ <h3 id="searchlabel">Quick search</h3>
       &#169;2015-2024 Phimeca.
 
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.2.6</a>
-      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
 
       |
       <a href="../_sources/_generated/otwrapy.create_logger.rst.txt"
@@ -155,7 +156,7 @@ <h3 id="searchlabel">Quick search</h3>
 
 
     <a href="https://github.com/openturns/otwrapy" class="github">
-        <img style="position: absolute; top: 0; right: 0; border: 0;" src="https://github.blog/wp-content/uploads/2008/12/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"  class="github"/>
+        <img src="../_static/github-banner.svg" alt="Fork me on GitHub" class="github"/>
     </a>