doc: update doc

onera · Jul 11, 2024 · 91072a1 · 91072a1
1 parent 08ca177
commit 91072a1
Show file tree

Hide file tree

Showing 37 changed files with 438 additions and 314 deletions.
diff --git a/.gitignore b/.gitignore
@@ -6,6 +6,7 @@ core.*
 setup.cfg
 Dist
 docs/doc/Examples
+docs/doc/*.pdf
 docs/Download
 Cassiopee/KCore/merge.l
 Cassiopee/XCore/merge.l

diff --git a/Cassiopee/CPlot/doc/source/CPlot.rst b/Cassiopee/CPlot/doc/source/CPlot.rst
@@ -20,7 +20,7 @@ For use with the array interface, you have to import CPlot module::
 
 For use with the pyTree interface::
 
-    import CPlot.PyTree as CPlot
+   import CPlot.PyTree as CPlot
 
 
 .. py:module:: CPlot

diff --git a/Cassiopee/Distributor2/doc/install b/Cassiopee/Distributor2/doc/install
diff --git a/Cassiopee/KCore/doc/install b/Cassiopee/KCore/doc/install
@@ -77,7 +77,7 @@ 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
+sed -i 's/Geom\.Geom/geom/g' $FILE
 #sed -i 's/Geom\:{/geom\:{/g' $FILE
 
 sed -i 's/Compressor\.Compressor/Compressor/g' $FILE
@@ -139,7 +139,6 @@ sed -i 's/CPlot\.CPlot/CPlot/g' $FILE
 
 sed -i 's/Intersector\.Intersector/Intersector/g' $FILE
 
-
 cp build/searchindex.js $DEST
 cp build/genindex.html $DEST
 cp build/py-modindex.html $DEST

diff --git a/docs/doc/CPlot.html b/docs/doc/CPlot.html
@@ -1,17 +1,21 @@
+
 <!DOCTYPE html>
 
-<html lang="en" data-content_root="./">
+<html lang="en">
   <head>
     <meta charset="ASCII" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
     <title>CPlot: a light plotter for arrays/pyTree &#8212; CPlot 4.0 documentation</title>
-    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
-    <link rel="stylesheet" type="text/css" href="_static/classic.css?v=514cf933" />
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+    <link rel="stylesheet" type="text/css" href="_static/classic.css" />
 
-    <script src="_static/documentation_options.js?v=9f5556dd"></script>
-    <script src="_static/doctools.js?v=888ff710"></script>
-    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+    <script src="_static/jquery.js"></script>
+    <script src="_static/underscore.js"></script>
+    <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
+    <script src="_static/doctools.js"></script>
+    <script src="_static/sphinx_highlight.js"></script>
 
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" /> 
@@ -51,9 +55,9 @@ <h2>Preamble</h2>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">CPlot.PyTree</span> <span class="k">as</span> <span class="nn">CPlot</span>
 </pre></div>
 </div>
-</section>
+<span class="target" id="module-CPlot"></span></section>
 <section id="list-of-functions">
-<span id="module-CPlot"></span><h2>List of functions</h2>
+<h2>List of functions</h2>
 <p><strong>&#8211; Actions</strong></p>
 <table class="autosummary longtable docutils align-default">
 <tbody>
@@ -1753,7 +1757,7 @@ <h3>Navigation</h3>
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-    &#169; Copyright ONERA.
+        &#169; Copyright ONERA.
     </div>
   </body>
 </html>
diff --git a/docs/doc/Compressor.html b/docs/doc/Compressor.html
@@ -1,17 +1,21 @@
+
 <!DOCTYPE html>
 
-<html lang="en" data-content_root="./">
+<html lang="en">
   <head>
     <meta charset="ASCII" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
     <title>Compressor: Field compression module &#8212; Compressor 4.0 documentation</title>
-    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
-    <link rel="stylesheet" type="text/css" href="_static/classic.css?v=514cf933" />
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+    <link rel="stylesheet" type="text/css" href="_static/classic.css" />
 
-    <script src="_static/documentation_options.js?v=9f5556dd"></script>
-    <script src="_static/doctools.js?v=888ff710"></script>
-    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+    <script src="_static/jquery.js"></script>
+    <script src="_static/underscore.js"></script>
+    <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
+    <script src="_static/doctools.js"></script>
+    <script src="_static/sphinx_highlight.js"></script>
 
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" /> 
@@ -49,9 +53,9 @@ <h2>Preamble</h2>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">Compressor.PyTree</span> <span class="k">as</span> <span class="nn">Compressor</span>
 </pre></div>
 </div>
-</section>
+<span class="target" id="module-Compressor"></span></section>
 <section id="list-of-functions">
-<span id="module-Compressor"></span><h2>List of functions</h2>
+<h2>List of functions</h2>
 <p><strong>&#8211; Index field compression</strong></p>
 <table class="autosummary longtable docutils align-default">
 <tbody>
@@ -588,7 +592,7 @@ <h3>Navigation</h3>
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-    &#169; Copyright ONERA.
+        &#169; Copyright ONERA.
     </div>
   </body>
 </html>
diff --git a/docs/doc/Connector.html b/docs/doc/Connector.html
@@ -1,17 +1,21 @@
+
 <!DOCTYPE html>
 
-<html lang="en" data-content_root="./">
+<html lang="en">
   <head>
     <meta charset="ASCII" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
     <title>Connector: Grid connectivity module &#8212; Connector 4.0 documentation</title>
-    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
-    <link rel="stylesheet" type="text/css" href="_static/classic.css?v=514cf933" />
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+    <link rel="stylesheet" type="text/css" href="_static/classic.css" />
 
-    <script src="_static/documentation_options.js?v=9f5556dd"></script>
-    <script src="_static/doctools.js?v=888ff710"></script>
-    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+    <script src="_static/jquery.js"></script>
+    <script src="_static/underscore.js"></script>
+    <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
+    <script src="_static/doctools.js"></script>
+    <script src="_static/sphinx_highlight.js"></script>
 
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" /> 
@@ -52,9 +56,9 @@ <h2>Preamble</h2>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">Connector.PyTree</span> <span class="k">as</span> <span class="nn">X</span>
 </pre></div>
 </div>
-</section>
+<span class="target" id="module-Connector"></span></section>
 <section id="list-of-functions">
-<span id="module-Connector"></span><h2>List of functions</h2>
+<h2>List of functions</h2>
 <p><strong>&#8211; Multiblock connectivity</strong></p>
 <table class="autosummary longtable docutils align-default">
 <tbody>
@@ -1159,7 +1163,7 @@ <h3>Navigation</h3>
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-    &#169; Copyright ONERA.
+        &#169; Copyright ONERA.
     </div>
   </body>
 </html>
diff --git a/docs/doc/Connector_IBM.html b/docs/doc/Connector_IBM.html
@@ -1,17 +1,21 @@
+
 <!DOCTYPE html>
 
-<html lang="en" data-content_root="./">
+<html lang="en">
   <head>
     <meta charset="ASCII" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
     <title>Connector.IBM: immersed boundary method grid connectivity module &#8212; Connector 4.0 documentation</title>
-    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
-    <link rel="stylesheet" type="text/css" href="_static/classic.css?v=514cf933" />
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+    <link rel="stylesheet" type="text/css" href="_static/classic.css" />
 
-    <script src="_static/documentation_options.js?v=9f5556dd"></script>
-    <script src="_static/doctools.js?v=888ff710"></script>
-    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+    <script src="_static/jquery.js"></script>
+    <script src="_static/underscore.js"></script>
+    <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
+    <script src="_static/doctools.js"></script>
+    <script src="_static/sphinx_highlight.js"></script>
 
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" /> 
@@ -298,7 +302,7 @@ <h3>Navigation</h3>
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-    &#169; Copyright ONERA.
+        &#169; Copyright ONERA.
     </div>
   </body>
 </html>
diff --git a/docs/doc/Converter.html b/docs/doc/Converter.html
@@ -1,17 +1,21 @@
+
 <!DOCTYPE html>
 
-<html lang="en" data-content_root="./">
+<html lang="en">
   <head>
     <meta charset="ASCII" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
     <title>Converter: CFD data conversion module &#8212; Converter 4.0 documentation</title>
-    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
-    <link rel="stylesheet" type="text/css" href="_static/classic.css?v=514cf933" />
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+    <link rel="stylesheet" type="text/css" href="_static/classic.css" />
 
-    <script src="_static/documentation_options.js?v=9f5556dd"></script>
-    <script src="_static/doctools.js?v=888ff710"></script>
-    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+    <script src="_static/jquery.js"></script>
+    <script src="_static/underscore.js"></script>
+    <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
+    <script src="_static/doctools.js"></script>
+    <script src="_static/sphinx_highlight.js"></script>
 
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" /> 
@@ -80,9 +84,9 @@ <h2>Preamble</h2>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">Converter.PyTree</span> <span class="k">as</span> <span class="nn">C</span>
 </pre></div>
 </div>
-</section>
+<span class="target" id="module-Converter"></span></section>
 <section id="name-standardisation">
-<span id="module-Converter"></span><h2>Name standardisation</h2>
+<h2>Name standardisation</h2>
 <p>Some functions of Converter, Post and other modules perform specific treatments for
 given variables. For instance, the computeVariables function in the Post module can
 compute the pressure automatically if density and velocity are defined with their
@@ -5596,7 +5600,7 @@ <h3>Navigation</h3>
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-    &#169; Copyright ONERA.
+        &#169; Copyright ONERA.
     </div>
   </body>
 </html>