[UPD] HTML documentation

OCA · Apr 5, 2024 · ba4ff8e · ba4ff8e
1 parent a6a665a
commit ba4ff8e
Show file tree

Hide file tree

Showing 17 changed files with 56 additions and 38 deletions.
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 99646d411e17bb2ddb83efcc5512545c
+config: dff726eb23f8acb81b348fe05805b091
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.doctrees/API.doctree b/docs/.doctrees/API.doctree
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/API.html b/docs/API.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>OpenUpgrade API &mdash; OpenUpgrade Library 0.1.dev1+g6cc596c documentation</title>
+  <title>OpenUpgrade API &mdash; OpenUpgrade Library 0.1.dev1+ga6a665a documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=be2d82bc"></script>
+        <script src="_static/documentation_options.js?v=971198ed"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -37,7 +37,7 @@
             OpenUpgrade Library
           </a>
               <div class="version">
-                0.1.dev1+g6cc596c
+                0.1.dev1+ga6a665a
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -58,6 +58,7 @@
 <li class="toctree-l3"><a class="reference internal" href="#openupgradelib.openupgrade.add_xmlid"><code class="docutils literal notranslate"><span class="pre">add_xmlid()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#openupgradelib.openupgrade.check_values_selection_field"><code class="docutils literal notranslate"><span class="pre">check_values_selection_field()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#openupgradelib.openupgrade.chunked"><code class="docutils literal notranslate"><span class="pre">chunked()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#openupgradelib.openupgrade.clean_transient_models"><code class="docutils literal notranslate"><span class="pre">clean_transient_models()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#openupgradelib.openupgrade.column_exists"><code class="docutils literal notranslate"><span class="pre">column_exists()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#openupgradelib.openupgrade.convert_field_to_html"><code class="docutils literal notranslate"><span class="pre">convert_field_to_html()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#openupgradelib.openupgrade.convert_to_company_dependent"><code class="docutils literal notranslate"><span class="pre">convert_to_company_dependent()</span></code></a></li>
@@ -284,6 +285,20 @@ <h1>OpenUpgrade API<a class="headerlink" href="#openupgrade-api" title="Link to
 at the time. Don’t nest calls to this method.</p>
 </dd></dl>
 
+<dl class="py function">
+<dt class="sig sig-object py" id="openupgradelib.openupgrade.clean_transient_models">
+<span class="sig-prename descclassname"><span class="pre">openupgradelib.openupgrade.</span></span><span class="sig-name descname"><span class="pre">clean_transient_models</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cr</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openupgradelib.openupgrade.clean_transient_models" title="Link to this definition"></a></dt>
+<dd><p>Clean transient models to prevent possible issues due to
+chained data.</p>
+<p>To be run at the base pre-migration script for having a general scope.
+Only works on &gt; v8.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>cr</strong> – Database cursor.</p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py function">
 <dt class="sig sig-object py" id="openupgradelib.openupgrade.column_exists">
 <span class="sig-prename descclassname"><span class="pre">openupgradelib.openupgrade.</span></span><span class="sig-name descname"><span class="pre">column_exists</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">table</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">column</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openupgradelib.openupgrade.column_exists" title="Link to this definition"></a></dt>

diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.1.dev1+g6cc596c',
+    VERSION: '0.1.dev1+ga6a665a',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/authors.html b/docs/authors.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Credits &mdash; OpenUpgrade Library 0.1.dev1+g6cc596c documentation</title>
+  <title>Credits &mdash; OpenUpgrade Library 0.1.dev1+ga6a665a documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=be2d82bc"></script>
+        <script src="_static/documentation_options.js?v=971198ed"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -37,7 +37,7 @@
             OpenUpgrade Library
           </a>
               <div class="version">
-                0.1.dev1+g6cc596c
+                0.1.dev1+ga6a665a
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

diff --git a/docs/contributing.html b/docs/contributing.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Contributing &mdash; OpenUpgrade Library 0.1.dev1+g6cc596c documentation</title>
+  <title>Contributing &mdash; OpenUpgrade Library 0.1.dev1+ga6a665a documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=be2d82bc"></script>
+        <script src="_static/documentation_options.js?v=971198ed"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -37,7 +37,7 @@
             OpenUpgrade Library
           </a>
               <div class="version">
-                0.1.dev1+g6cc596c
+                0.1.dev1+ga6a665a
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Index &mdash; OpenUpgrade Library 0.1.dev1+g6cc596c documentation</title>
+  <title>Index &mdash; OpenUpgrade Library 0.1.dev1+ga6a665a documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=be2d82bc"></script>
+        <script src="_static/documentation_options.js?v=971198ed"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -34,7 +34,7 @@
             OpenUpgrade Library
           </a>
               <div class="version">
-                0.1.dev1+g6cc596c
+                0.1.dev1+ga6a665a
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -130,6 +130,8 @@ <h2 id="C">C</h2>
       <li><a href="API.html#openupgradelib.openupgrade.check_values_selection_field">check_values_selection_field() (in module openupgradelib.openupgrade)</a>
 </li>
       <li><a href="API.html#openupgradelib.openupgrade.chunked">chunked() (in module openupgradelib.openupgrade)</a>
+</li>
+      <li><a href="API.html#openupgradelib.openupgrade.clean_transient_models">clean_transient_models() (in module openupgradelib.openupgrade)</a>
 </li>
       <li><a href="API.html#openupgradelib.openupgrade.column_exists">column_exists() (in module openupgradelib.openupgrade)</a>
 </li>
@@ -138,11 +140,11 @@ <h2 id="C">C</h2>
       <li><a href="API.html#openupgradelib.openupgrade_120.convert_field_bootstrap_3to4">convert_field_bootstrap_3to4() (in module openupgradelib.openupgrade_120)</a>
 </li>
       <li><a href="API.html#openupgradelib.openupgrade_160.convert_field_bootstrap_4to5">convert_field_bootstrap_4to5() (in module openupgradelib.openupgrade_160)</a>
-</li>
-      <li><a href="API.html#openupgradelib.openupgrade.convert_field_to_html">convert_field_to_html() (in module openupgradelib.openupgrade)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="API.html#openupgradelib.openupgrade.convert_field_to_html">convert_field_to_html() (in module openupgradelib.openupgrade)</a>
+</li>
       <li><a href="API.html#openupgradelib.openupgrade_120.convert_string_bootstrap_3to4">convert_string_bootstrap_3to4() (in module openupgradelib.openupgrade_120)</a>
 </li>
       <li><a href="API.html#openupgradelib.openupgrade_160.convert_string_bootstrap_4to5">convert_string_bootstrap_4to5() (in module openupgradelib.openupgrade_160)</a>

diff --git a/docs/history.html b/docs/history.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>History &mdash; OpenUpgrade Library 0.1.dev1+g6cc596c documentation</title>
+  <title>History &mdash; OpenUpgrade Library 0.1.dev1+ga6a665a documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=be2d82bc"></script>
+        <script src="_static/documentation_options.js?v=971198ed"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -36,7 +36,7 @@
             OpenUpgrade Library
           </a>
               <div class="version">
-                0.1.dev1+g6cc596c
+                0.1.dev1+ga6a665a
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

diff --git a/docs/index.html b/docs/index.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Welcome to OpenUpgrade Library’s documentation! &mdash; OpenUpgrade Library 0.1.dev1+g6cc596c documentation</title>
+  <title>Welcome to OpenUpgrade Library’s documentation! &mdash; OpenUpgrade Library 0.1.dev1+ga6a665a documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=be2d82bc"></script>
+        <script src="_static/documentation_options.js?v=971198ed"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -36,7 +36,7 @@
             OpenUpgrade Library
           </a>
               <div class="version">
-                0.1.dev1+g6cc596c
+                0.1.dev1+ga6a665a
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -112,6 +112,7 @@ <h1>Welcome to OpenUpgrade Library’s documentation!<a class="headerlink" href=
 <li class="toctree-l3"><a class="reference internal" href="API.html#openupgradelib.openupgrade.add_xmlid"><code class="docutils literal notranslate"><span class="pre">add_xmlid()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="API.html#openupgradelib.openupgrade.check_values_selection_field"><code class="docutils literal notranslate"><span class="pre">check_values_selection_field()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="API.html#openupgradelib.openupgrade.chunked"><code class="docutils literal notranslate"><span class="pre">chunked()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="API.html#openupgradelib.openupgrade.clean_transient_models"><code class="docutils literal notranslate"><span class="pre">clean_transient_models()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="API.html#openupgradelib.openupgrade.column_exists"><code class="docutils literal notranslate"><span class="pre">column_exists()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="API.html#openupgradelib.openupgrade.convert_field_to_html"><code class="docutils literal notranslate"><span class="pre">convert_field_to_html()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="API.html#openupgradelib.openupgrade.convert_to_company_dependent"><code class="docutils literal notranslate"><span class="pre">convert_to_company_dependent()</span></code></a></li>

diff --git a/docs/installation.html b/docs/installation.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Installation &mdash; OpenUpgrade Library 0.1.dev1+g6cc596c documentation</title>
+  <title>Installation &mdash; OpenUpgrade Library 0.1.dev1+ga6a665a documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=be2d82bc"></script>
+        <script src="_static/documentation_options.js?v=971198ed"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -37,7 +37,7 @@
             OpenUpgrade Library
           </a>
               <div class="version">
-                0.1.dev1+g6cc596c
+                0.1.dev1+ga6a665a
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/py-modindex.html b/docs/py-modindex.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Python Module Index &mdash; OpenUpgrade Library 0.1.dev1+g6cc596c documentation</title>
+  <title>Python Module Index &mdash; OpenUpgrade Library 0.1.dev1+ga6a665a documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=be2d82bc"></script>
+        <script src="_static/documentation_options.js?v=971198ed"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -37,7 +37,7 @@
             OpenUpgrade Library
           </a>
               <div class="version">
-                0.1.dev1+g6cc596c
+                0.1.dev1+ga6a665a
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

diff --git a/docs/readme.html b/docs/readme.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>OpenUpgrade Library &mdash; OpenUpgrade Library 0.1.dev1+g6cc596c documentation</title>
+  <title>OpenUpgrade Library &mdash; OpenUpgrade Library 0.1.dev1+ga6a665a documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=be2d82bc"></script>
+        <script src="_static/documentation_options.js?v=971198ed"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -37,7 +37,7 @@
             OpenUpgrade Library
           </a>
               <div class="version">
-                0.1.dev1+g6cc596c
+                0.1.dev1+ga6a665a
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">