docs: minor update

onera · Jul 26, 2024 · fe93cd8 · fe93cd8
1 parent ddb936e
commit fe93cd8
Show file tree

Hide file tree

Showing 11 changed files with 110 additions and 26 deletions.
diff --git a/Cassiopee/CPlot/doc/source/tkPlotXY.rst b/Cassiopee/CPlot/doc/source/tkPlotXY.rst
@@ -1,7 +1,7 @@
 .. tkPlotXY documentation master file
 
-tkPlotXY : plot of curves
-==========================
+tkPlotXY: plot of curves
+=========================
 
 Preamble
 ########

diff --git a/Cassiopee/Geom/doc/source/Geom.rst b/Cassiopee/Geom/doc/source/Geom.rst
@@ -118,7 +118,7 @@ A polyline is defined as a C0 i-array which contains only the polyline points (w
 
     Create a point of coordinates P=(x,y,z).
 
-    :param P:  (x,y,z) of point
+    :param P: (x,y,z) of point
     :type P: 3-tuple of floats 
     :return: a point
     :rtype: one array/zone (NODE)

diff --git a/Cassiopee/KCore/doc/install b/Cassiopee/KCore/doc/install
@@ -56,11 +56,11 @@ sed -i 's/Converter\.elsAProfile\.Converter\.elsAProfile/Converter\.elsAProfile/
 sed -i 's/Converter\.Filter\.Converter\.Filter/Converter\.Filter/g' $FILE
 sed -i 's/Converter\.Converter\.PyTree/Converter\.PyTree/g' $FILE
 sed -i 's/Converter\.Converter\.Array3D/Converter\.Array3D/g' $FILE
-sed -i 's/Converter\.Converter/Converter/g' $FILE
+sed -i 's/Converter\.Converter/converter/g' $FILE # FAIL 
 #sed -i 's/Converter\:{/converter\:{/g' $FILE
 
 sed -i 's/Geom\.IBM\.Geom\.IBM/Geom\.IBM/g' $FILE
-sed -i 's/Geom\.Geom/Geom/g' $FILE
+sed -i 's/Geom\.Geom/geom/g' $FILE # FAIL
 #sed -i 's/Geom\:{/geom\:{/g' $FILE
 
 sed -i 's/Compressor\.Compressor/Compressor/g' $FILE
@@ -75,12 +75,12 @@ sed -i 's/Post\.Rotor\.Post\.Rotor/Post\.Rotor/g' $FILE
 sed -i 's/Post\.IBM\.Post\.IBM/Post\.IBM/g' $FILE
 sed -i 's/Post\.ExtraVariables2\.Post\.ExtraVariables2/Post\.ExtraVariables2/g' $FILE
 sed -i 's/Post\.Post/Post/g' $FILE
-#sed -i 's/Post\:{/post\:{/g' $FILE
 
 sed -i 's/RigidMotion\.RigidMotion/RigidMotion/g' $FILE
 
 sed -i 's/CPlot\.Decorator\.CPlot\.Decorator/CPlot\.Decorator/g' $FILE
-sed -i 's/CPlot\.CPlot/CPlot/g' $FILE
+#sed -i 's/CPlot\.CPlot\.PyTree/CPlot\.PyTree/g' $FILE
+sed -i 's/CPlot\.CPlot/cplot/g' $FILE # FAIL
 #sed -i 's/CPlot\:{/CPlot\:{/g' $FILE
 
 sed -i 's/Intersector\.Intersector/Intersector/g' $FILE
@@ -93,11 +93,11 @@ sed -i 's/Converter\.elsAProfile\.Converter\.elsAProfile/Converter\.elsAProfile/
 sed -i 's/Converter\.Filter\.Converter\.Filter/Converter\.Filter/g' $FILE
 sed -i 's/Converter\.Converter\.PyTree/Converter\.PyTree/g' $FILE
 sed -i 's/Converter\.Converter\.Array3D/Converter\.Array3D/g' $FILE
-sed -i 's/Converter\.Converter/Converter/g' $FILE # FAIL 
+sed -i 's/Converter\.Converter/Converter/g' $FILE
 #sed -i 's/Converter\:{/converter\:{/g' $FILE
 
 sed -i 's/Geom\.IBM\.Geom\.IBM/Geom\.IBM/g' $FILE
-sed -i 's/Geom\.Geom/Geom/g' $FILE # FAIL   
+sed -i 's/Geom\.Geom/Geom/g' $FILE
 #sed -i 's/Geom\:{/geom\:{/g' $FILE
 
 sed -i 's/Compressor\.Compressor/Compressor/g' $FILE
@@ -112,12 +112,11 @@ sed -i 's/Post\.IBM\.Post\.IBM/Post\.IBM/g' $FILE
 sed -i 's/Post\.Rotor\.Post\.Rotor/Post\.Rotor/g' $FILE
 sed -i 's/Post\.ExtraVariables2\.Post\.ExtraVariables2/Post\.ExtraVariables2/g' $FILE
 sed -i 's/Post\.Post/Post/g' $FILE
-#sed -i 's/Post\:{/post\:{/g' $FILE
 
 sed -i 's/RigidMotion\.RigidMotion/RigidMotion/g' $FILE
 
 sed -i 's/CPlot\.Decorator\.CPlot\.Decorator/CPlot\.Decorator/g' $FILE
-sed -i 's/CPlot\.CPlot/CPlot/g' $FILE # FAIL 
+sed -i 's/CPlot\.CPlot/CPlot/g' $FILE
 #sed -i 's/CPlot\:{/cplot\:{/g' $FILE
 
 sed -i 's/Intersector\.Intersector/Intersector/g' $FILE

diff --git a/Cassiopee/KCore/doc/source/Geom.rst b/Cassiopee/KCore/doc/source/Geom.rst
@@ -118,7 +118,7 @@ A polyline is defined as a C0 i-array which contains only the polyline points (w
 
     Create a point of coordinates P=(x,y,z).
 
-    :param P:  (x,y,z) of point
+    :param P: (x,y,z) of point
     :type P: 3-tuple of floats 
     :return: a point
     :rtype: one array/zone (NODE)

diff --git a/docs/doc/CPlot.html b/docs/doc/CPlot.html
@@ -223,7 +223,7 @@ <h3>Actions</h3>
 <li><p><strong>displayInfo</strong> (<em>int</em>) &#8211; 0 means no info display (default: 1)</p></li>
 <li><p><strong>displayIsoLegend</strong> (<em>int</em>) &#8211; 0 means no iso legend display (default: 0)</p></li>
 <li><p><strong>meshStyle</strong> (<em>int</em>) &#8211; 0: white solid and red wireframe, 1: colored wireframe, 2: colored solid and wireframe, 3: cyan solid and black wireframe (default: 2)</p></li>
-<li><p><strong>solidStyle</strong> (<em>int</em>) &#8211; 0: blue, 1: colored by zone, 3: white, 4: colored by zone outlined (default: 1)</p></li>
+<li><p><strong>solidStyle</strong> (<em>int</em>) &#8211; 0: blue, 1: colored by zone, 3: white, 4: colored by zone outlined (default: 0)</p></li>
 <li><p><strong>scalarStyle</strong> (<em>int</em>) &#8211; 0: banded, 1: banded+mesh, 2: lines, 3: lines+mesh (default: 0)</p></li>
 <li><p><strong>vectorStyle</strong> (<em>int</em>) &#8211; 0: RGB, 1: arrows, 2: lines (default: 0)</p></li>
 <li><p><strong>vectorDensity</strong> (<em>float</em>) &#8211; the density of vectors (default: 0.)</p></li>
@@ -1775,4 +1775,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="#">CPlot 4.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">CPlot: a light plotter for arrays/pyTree</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    </div>
+  </body>
+</html>
diff --git a/docs/doc/Decorator.html b/docs/doc/Decorator.html
@@ -66,7 +66,7 @@ <h2>List of functions</h2>
 <td><p>Create text.</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="#CPlot.Decorator.CPlot.Decorator.createArrow" title="CPlot.Decorator.CPlot.Decorator.createArrow"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CPlot.Decorator.createArrow</span></code></a>(ax,&#160;X1,&#160;X2[,&#160;...])</p></td>
-<td><p></p></td>
+<td><p>Draw an arrow on figure.</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="#CPlot.Decorator.CPlot.Decorator.savefig" title="CPlot.Decorator.CPlot.Decorator.savefig"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CPlot.Decorator.savefig</span></code></a>(fileName[,&#160;pad])</p></td>
 <td><p>Save current figure in a file.</p></td>
@@ -185,6 +185,7 @@ <h3>Actions</h3>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
+<li><p><strong>ax</strong> (<em>matplotlib axis</em>) &#8211; subplot axis</p></li>
 <li><p><strong>posx</strong> (<em>float</em>) &#8211; position of text in x axis</p></li>
 <li><p><strong>posy</strong> (<em>float</em>) &#8211; position of text in y axis</p></li>
 <li><p><strong>text</strong> (<em>string</em>) &#8211; text to be displayed</p></li>
@@ -431,4 +432,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="CPlot.html">CPlot 4.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">CPlot.Decorator: decoration of CPlot images using matplotlib</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    </div>
+  </body>
+</html>
diff --git a/docs/doc/_sources/Geom.rst.txt b/docs/doc/_sources/Geom.rst.txt
@@ -118,7 +118,7 @@ A polyline is defined as a C0 i-array which contains only the polyline points (w
 
     Create a point of coordinates P=(x,y,z).
 
-    :param P:  (x,y,z) of point
+    :param P: (x,y,z) of point
     :type P: 3-tuple of floats 
     :return: a point
     :rtype: one array/zone (NODE)

diff --git a/docs/doc/_sources/tkPlotXY.rst.txt b/docs/doc/_sources/tkPlotXY.rst.txt
@@ -1,7 +1,7 @@
 .. tkPlotXY documentation master file
 
-tkPlotXY : plot of curves
-==========================
+tkPlotXY: plot of curves
+=========================
 
 Preamble
 ########

diff --git a/docs/doc/searchindex.js b/docs/doc/searchindex.js
diff --git a/docs/doc/tkCassiopee.html b/docs/doc/tkCassiopee.html
@@ -476,4 +476,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="CPlot.html">CPlot 4.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Preamble</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    </div>
+  </body>
+</html>
diff --git a/docs/doc/tkPlotXY.html b/docs/doc/tkPlotXY.html
@@ -6,7 +6,7 @@
     <meta charset="ASCII" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>tkPlotXY : plot of curves &#8212; CPlot 4.0 documentation</title>
+    <title>tkPlotXY: plot of curves &#8212; CPlot 4.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/classic.css" />
 
@@ -30,7 +30,7 @@ <h3>Navigation</h3>
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
         <li class="nav-item nav-item-0"><a href="CPlot.html">CPlot 4.0 documentation</a> &#187;</li>
-        <li class="nav-item nav-item-this"><a href="">tkPlotXY : plot of curves</a></li> 
+        <li class="nav-item nav-item-this"><a href="">tkPlotXY: plot of curves</a></li> 
       </ul>
     </div>  
 
@@ -40,7 +40,7 @@ <h3>Navigation</h3>
           <div class="body" role="main">
 
   <section id="tkplotxy-plot-of-curves">
-<h1>tkPlotXY : plot of curves</h1>
+<h1>tkPlotXY: plot of curves</h1>
 <section id="preamble">
 <h2>Preamble</h2>
 <p>tkPlotXY is a 2D plotting library based on Matplotlib. The aim of tkPlotXY is to provide
@@ -1198,7 +1198,7 @@ <h2>Index</h2>
   <div>
     <h3><a href="CPlot.html">Table of Contents</a></h3>
     <ul>
-<li><a class="reference internal" href="#">tkPlotXY : plot of curves</a><ul>
+<li><a class="reference internal" href="#">tkPlotXY: plot of curves</a><ul>
 <li><a class="reference internal" href="#preamble">Preamble</a></li>
 <li><a class="reference internal" href="#one-line-plot-function">One line plot function</a><ul>
 <li><a class="reference internal" href="#tkPlotXY.tkPlotXY.plot"><code class="docutils literal notranslate"><span class="pre">tkPlotXY.plot()</span></code></a></li>
@@ -1431,4 +1431,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="CPlot.html">CPlot 4.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">tkPlotXY: plot of curves</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    </div>
+  </body>
+</html>