docs: doc improvement

onera · Aug 1, 2024 · 3d80088 · 3d80088
1 parent 1738c93
commit 3d80088
Show file tree

Hide file tree

Showing 11 changed files with 954 additions and 1,889 deletions.
diff --git a/Cassiopee/CPlot/doc/source/tkPlotXY.rst b/Cassiopee/CPlot/doc/source/tkPlotXY.rst
diff --git a/Cassiopee/CPlot/doc/source/tkPlotXYClasses.rst b/Cassiopee/CPlot/doc/source/tkPlotXYClasses.rst
diff --git a/Cassiopee/Distributor2/doc/source/Distributor2.rst b/Cassiopee/Distributor2/doc/source/Distributor2.rst
@@ -304,8 +304,6 @@ Various operations
 
     .. literalinclude:: ../build/Examples/Distributor2/printProcStatsPT.py    
 
-    .. note:: new in version 2.7.
-
 
 
 .. toctree::

diff --git a/Cassiopee/Post/doc/source/Post.rst b/Cassiopee/Post/doc/source/Post.rst
@@ -711,7 +711,7 @@ Solution selection
 
     .. literalinclude:: ../build/Examples/Post/frontFaces.py
 
-   * `Select a front in a tag (pyTree) <Examples/Post/frontFacesPT.py>`_:
+    * `Select a front in a tag (pyTree) <Examples/Post/frontFacesPT.py>`_:
 
     .. literalinclude:: ../build/Examples/Post/frontFacesPT.py
 
@@ -1329,10 +1329,10 @@ Solution integration
     must be input separately, for pyTree, they must be defined in
     each zone.
 
-.. py:function:: Post.integ(A, var='F')
-
 ---------------------------------------
 
+.. py:function:: Post.integ(A, var='F')
+
     Compute the integral :math:`\int F.dS` of a scalar field (whose name is in var string) over
     the geometry defined by arrays containing the coordinates + field ( + an optional "ratio" field ).
     Solution and ratio can be located at nodes or at centers.

diff --git a/docs/doc/Distributor2.html b/docs/doc/Distributor2.html
@@ -591,10 +591,6 @@ <h3>Various operations</h3>
 <span class="n">C</span><span class="o">.</span><span class="n">convertPyTree2File</span><span class="p">(</span><span class="n">t</span><span class="p">,</span> <span class="s1">&#39;out.cgns&#39;</span><span class="p">)</span>
 </pre></div>
 </div>
-<div class="admonition note">
-<p class="admonition-title">Note</p>
-<p>new in version 2.7.</p>
-</div>
 </dd></dl>
 
 <div class="toctree-wrapper compound">
@@ -725,4 +721,25 @@ <h3 id="searchlabel">Quick search</h3>
     }
 }
 
-</script>
+</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="#">Distributor2 4.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Distributor2: distribution of grids on processors</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    </div>
+  </body>
+</html>
diff --git a/docs/doc/ExtraVariables2.html b/docs/doc/ExtraVariables2.html
@@ -39,7 +39,7 @@ <h3>Navigation</h3>
         <div class="bodywrapper">
           <div class="body" role="main">
 
-  <section id="extravariables2-derived-fields-from-primitive-variables">
+  <section id="post-extravariables2-derived-fields-from-primitive-variables">
 <h1>Post.ExtraVariables2: derived fields from primitive variables</h1>
 <p>This module compute derived fields from primitive variables.</p>
 <span class="target" id="module-Post.ExtraVariables2"></span><section id="list-of-functions">
@@ -894,4 +894,25 @@ <h3 id="searchlabel">Quick search</h3>
     }
 }
 
-</script>
+</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="Post.html">Post 4.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Post.ExtraVariables2: derived fields from primitive variables</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    </div>
+  </body>
+</html>
diff --git a/docs/doc/Post.html b/docs/doc/Post.html
@@ -1437,23 +1437,16 @@ <h3>Solution selection</h3>
 <dl class="py function">
 <dt class="sig sig-object py" id="Post.frontFaces">
 <span class="sig-prename descclassname"><span class="pre">Post.</span></span><span class="sig-name descname"><span class="pre">frontFaces</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">a</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag</span></span></em><span class="sig-paren">)</span></dt>
-<dd><blockquote>
-<div><p>Select faces that are located at the boundary where a tag indicator change from 0 to 1.</p>
+<dd><p>Select faces that are located at the boundary where a tag indicator change from 0 to 1.</p>
 <dl class="field-list simple">
-<dt class="field-odd">param a<span class="colon">:</span></dt>
-<dd class="field-odd"><p>input data</p>
-</dd>
-<dt class="field-even">type a<span class="colon">:</span></dt>
-<dd class="field-even"><p>[array, list of arrays] or [pyTree, base, zone, list of zones]</p>
-</dd>
-<dt class="field-odd">param tag<span class="colon">:</span></dt>
-<dd class="field-odd"><p>variable name</p>
-</dd>
-<dt class="field-even">type tag<span class="colon">:</span></dt>
-<dd class="field-even"><p>string</p>
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>a</strong> (<em>[</em><em>array</em><em>, </em><em>list</em><em> of </em><em>arrays</em><em>] or </em><em>[</em><em>pyTree</em><em>, </em><em>base</em><em>, </em><em>zone</em><em>, </em><em>list</em><em> of </em><em>zones</em><em>]</em>) &#8211; input data</p></li>
+<li><p><strong>tag</strong> (<em>string</em>) &#8211; variable name</p></li>
+</ul>
 </dd>
-<dt class="field-odd">rtype<span class="colon">:</span></dt>
-<dd class="field-odd"><p>zone</p>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>zone</p>
 </dd>
 </dl>
 <p><em>Example of use:</em></p>
@@ -1475,12 +1468,10 @@ <h3>Solution selection</h3>
 <span class="n">C</span><span class="o">.</span><span class="n">convertArrays2File</span><span class="p">([</span><span class="n">a</span><span class="p">,</span><span class="n">f</span><span class="p">],</span> <span class="s1">&#39;out.plt&#39;</span><span class="p">)</span>
 </pre></div>
 </div>
-</div></blockquote>
 <ul class="simple">
 <li><p><a class="reference external" href="Examples/Post/frontFacesPT.py">Select a front in a tag (pyTree)</a>:</p></li>
 </ul>
-<blockquote>
-<div><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># - frontFaces (pyTree) -</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># - frontFaces (pyTree) -</span>
 <span class="kn">import</span> <span class="nn">Converter.PyTree</span> <span class="k">as</span> <span class="nn">C</span>
 <span class="kn">import</span> <span class="nn">Generator.PyTree</span> <span class="k">as</span> <span class="nn">G</span>
 <span class="kn">import</span> <span class="nn">Post.PyTree</span> <span class="k">as</span> <span class="nn">P</span>
@@ -1495,7 +1486,6 @@ <h3>Solution selection</h3>
 <span class="n">C</span><span class="o">.</span><span class="n">convertPyTree2File</span><span class="p">(</span><span class="n">t</span><span class="p">,</span> <span class="s1">&#39;out.cgns&#39;</span><span class="p">)</span>
 </pre></div>
 </div>
-</div></blockquote>
 </dd></dl>
 
 <hr class="docutils" />
@@ -2757,14 +2747,11 @@ <h3>Solution integration</h3>
 must be input separately, for pyTree, they must be defined in
 each zone.</p>
 </div></blockquote>
+<hr class="docutils" />
 <dl class="py function">
 <dt class="sig sig-object py" id="Post.integ">
 <span class="sig-prename descclassname"><span class="pre">Post.</span></span><span class="sig-name descname"><span class="pre">integ</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">A</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">var</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'F'</span></span></em><span class="sig-paren">)</span></dt>
-<dd></dd></dl>
-
-<hr class="docutils" />
-<blockquote>
-<div><p>Compute the integral <span class="math notranslate nohighlight">\(\int F.dS\)</span> of a scalar field (whose name is in var string) over
+<dd><p>Compute the integral <span class="math notranslate nohighlight">\(\int F.dS\)</span> of a scalar field (whose name is in var string) over
 the geometry defined by arrays containing the coordinates + field ( + an optional &#8220;ratio&#8221; field ).
 Solution and ratio can be located at nodes or at centers.</p>
 <p>For array interface:</p>
@@ -2777,23 +2764,17 @@ <h3>Solution integration</h3>
 </pre></div>
 </div>
 <dl class="field-list simple">
-<dt class="field-odd">param A<span class="colon">:</span></dt>
-<dd class="field-odd"><p>input data</p>
-</dd>
-<dt class="field-even">type  A<span class="colon">:</span></dt>
-<dd class="field-even"><p>[array, list of arrays] or [pyTree, base, zone, list of zones]</p>
-</dd>
-<dt class="field-odd">param var<span class="colon">:</span></dt>
-<dd class="field-odd"><p>field name</p>
-</dd>
-<dt class="field-even">type var<span class="colon">:</span></dt>
-<dd class="field-even"><p>string</p>
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>A</strong> (<em>[</em><em>array</em><em>, </em><em>list</em><em> of </em><em>arrays</em><em>] or </em><em>[</em><em>pyTree</em><em>, </em><em>base</em><em>, </em><em>zone</em><em>, </em><em>list</em><em> of </em><em>zones</em><em>]</em>) &#8211; input data</p></li>
+<li><p><strong>var</strong> (<em>string</em>) &#8211; field name</p></li>
+</ul>
 </dd>
-<dt class="field-odd">return<span class="colon">:</span></dt>
-<dd class="field-odd"><p>the result of integration</p>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>the result of integration</p>
 </dd>
-<dt class="field-even">rtype<span class="colon">:</span></dt>
-<dd class="field-even"><p>a list of 1 float</p>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>a list of 1 float</p>
 </dd>
 </dl>
 <p>Exists also as parallel distributed version (P.Mpi.integ).</p>
@@ -2835,7 +2816,8 @@ <h3>Solution integration</h3>
 <span class="c1">#&gt;&gt; [99.99999999999989]</span>
 </pre></div>
 </div>
-</div></blockquote>
+</dd></dl>
+
 <hr class="docutils" />
 <dl class="py function">
 <dt class="sig sig-object py" id="Post.integNorm">
@@ -3255,4 +3237,25 @@ <h3 id="searchlabel">Quick search</h3>
     }
 }
 
-</script>
+</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="#">Post 4.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Post: post-processing module</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    </div>
+  </body>
+</html>
diff --git a/docs/doc/Post_IBM.html b/docs/doc/Post_IBM.html
@@ -622,4 +622,25 @@ <h3 id="searchlabel">Quick search</h3>
     }
 }
 
-</script>
+</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="Post.html">Post 4.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Post.IBM: immersed boundary method specific post-processing</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    </div>
+  </body>
+</html>
diff --git a/docs/doc/Rotor.html b/docs/doc/Rotor.html
@@ -39,7 +39,7 @@ <h3>Navigation</h3>
         <div class="bodywrapper">
           <div class="body" role="main">
 
-  <section id="rotor-rotor-specific-post-processing">
+  <section id="post-rotor-rotor-specific-post-processing">
 <h1>Post.Rotor: rotor specific post-processing</h1>
 <p>Specific post-processing for rotors or propellers.</p>
 <p>Those functions work with a solution tree &#8220;t&#8221; or a blade surface tree &#8220;teff&#8221;.</p>
@@ -489,4 +489,25 @@ <h3 id="searchlabel">Quick search</h3>
     }
 }
 
-</script>
+</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="Post.html">Post 4.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Post.Rotor: rotor specific post-processing</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    </div>
+  </body>
+</html>