[UPD] HTML documentation

OCA · Oct 30, 2023 · ce39c0d · ce39c0d
1 parent 9b7dc0c
commit ce39c0d
Show file tree

Hide file tree

Showing 17 changed files with 80 additions and 36 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: b15bd972cfc9811ba208937b2ba3f174
+config: 2b628ef98734c567bcd246e1229455a5
 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="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>OpenUpgrade API &mdash; OpenUpgrade Library 0.1.dev1+g7ea979e documentation</title>
+  <title>OpenUpgrade API &mdash; OpenUpgrade Library 0.1.dev1+g9b7dc0c documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -13,7 +13,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=4c8ba79d"></script>
+        <script src="_static/documentation_options.js?v=c1ea034f"></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>
@@ -35,7 +35,7 @@
             OpenUpgrade Library
           </a>
               <div class="version">
-                0.1.dev1+g7ea979e
+                0.1.dev1+g9b7dc0c
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -129,6 +129,8 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="#methods-for-openupgrade-16-0">Methods for OpenUpgrade 16.0</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#openupgradelib.openupgrade_160.convert_field_bootstrap_4to5"><code class="docutils literal notranslate"><span class="pre">convert_field_bootstrap_4to5()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#openupgradelib.openupgrade_160.convert_string_bootstrap_4to5"><code class="docutils literal notranslate"><span class="pre">convert_string_bootstrap_4to5()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#openupgradelib.openupgrade_160.migrate_translations_to_jsonb"><code class="docutils literal notranslate"><span class="pre">migrate_translations_to_jsonb()</span></code></a></li>
 </ul>
 </li>
@@ -1314,6 +1316,42 @@ <h2>Methods for OpenUpgrade 16.0<a class="headerlink" href="#methods-for-openupg
 release.</p>
 <p id="module-openupgradelib.openupgrade_160">This module provides simple tools for OpenUpgrade migration, specific for
 the &gt;=16.0 migration.</p>
+<dl class="py function">
+<dt class="sig sig-object py" id="openupgradelib.openupgrade_160.convert_field_bootstrap_4to5">
+<span class="sig-prename descclassname"><span class="pre">openupgradelib.openupgrade_160.</span></span><span class="sig-name descname"><span class="pre">convert_field_bootstrap_4to5</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">env</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">model_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">field_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">domain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">method</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'orm'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openupgradelib.openupgrade_160.convert_field_bootstrap_4to5" title="Link to this definition"></a></dt>
+<dd><p>This converts all the values for the given model and field, being
+able to restrict to a domain of affected records.</p>
+<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>env</strong> – Odoo environment.</p></li>
+<li><p><strong>model_name</strong> – Name of the model that contains the field.</p></li>
+<li><p><strong>field_name</strong> – Name of the field that contains the BS3 HTML content.</p></li>
+<li><p><strong>domain</strong> – Optional domain for filtering records in the model</p></li>
+<li><p><strong>method</strong> – ‘orm’ (default) for using ORM; ‘sql’ for avoiding problems
+with extra triggers in ORM.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="openupgradelib.openupgrade_160.convert_string_bootstrap_4to5">
+<span class="sig-prename descclassname"><span class="pre">openupgradelib.openupgrade_160.</span></span><span class="sig-name descname"><span class="pre">convert_string_bootstrap_4to5</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">html_string</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pretty_print</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openupgradelib.openupgrade_160.convert_string_bootstrap_4to5" title="Link to this definition"></a></dt>
+<dd><p>Convert an HTML string from Bootstrap 4 to 5.</p>
+<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>html_string</strong> (<em>str</em>) – Raw HTML fragment to convert.</p></li>
+<li><p><strong>pretty_print</strong> (<em>bool</em>) – Indicate if you wish to return the HTML pretty formatted.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Return str<span class="colon">:</span></dt>
+<dd class="field-even"><p>Raw HTML fragment converted.</p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py function">
 <dt class="sig sig-object py" id="openupgradelib.openupgrade_160.migrate_translations_to_jsonb">
 <span class="sig-prename descclassname"><span class="pre">openupgradelib.openupgrade_160.</span></span><span class="sig-name descname"><span class="pre">migrate_translations_to_jsonb</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">env</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fields_spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openupgradelib.openupgrade_160.migrate_translations_to_jsonb" 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+g7ea979e',
+    VERSION: '0.1.dev1+g9b7dc0c',
     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="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Credits &mdash; OpenUpgrade Library 0.1.dev1+g7ea979e documentation</title>
+  <title>Credits &mdash; OpenUpgrade Library 0.1.dev1+g9b7dc0c documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -13,7 +13,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=4c8ba79d"></script>
+        <script src="_static/documentation_options.js?v=c1ea034f"></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>
@@ -35,7 +35,7 @@
             OpenUpgrade Library
           </a>
               <div class="version">
-                0.1.dev1+g7ea979e
+                0.1.dev1+g9b7dc0c
               </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="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Contributing &mdash; OpenUpgrade Library 0.1.dev1+g7ea979e documentation</title>
+  <title>Contributing &mdash; OpenUpgrade Library 0.1.dev1+g9b7dc0c documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -13,7 +13,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=4c8ba79d"></script>
+        <script src="_static/documentation_options.js?v=c1ea034f"></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>
@@ -35,7 +35,7 @@
             OpenUpgrade Library
           </a>
               <div class="version">
-                0.1.dev1+g7ea979e
+                0.1.dev1+g9b7dc0c
               </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+g7ea979e documentation</title>
+  <title>Index &mdash; OpenUpgrade Library 0.1.dev1+g9b7dc0c documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -12,7 +12,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=4c8ba79d"></script>
+        <script src="_static/documentation_options.js?v=c1ea034f"></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>
@@ -32,7 +32,7 @@
             OpenUpgrade Library
           </a>
               <div class="version">
-                0.1.dev1+g7ea979e
+                0.1.dev1+g9b7dc0c
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -134,12 +134,16 @@ <h2 id="C">C</h2>
       <li><a href="API.html#openupgradelib.openupgrade_90.convert_binary_field_to_attachment">convert_binary_field_to_attachment() (in module openupgradelib.openupgrade_90)</a>
 </li>
       <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_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>
 </li>
       <li><a href="API.html#openupgradelib.openupgrade.convert_to_company_dependent">convert_to_company_dependent() (in module openupgradelib.openupgrade)</a>
 </li>

diff --git a/docs/history.html b/docs/history.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>History &mdash; OpenUpgrade Library 0.1.dev1+g7ea979e documentation</title>
+  <title>History &mdash; OpenUpgrade Library 0.1.dev1+g9b7dc0c documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -13,7 +13,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=4c8ba79d"></script>
+        <script src="_static/documentation_options.js?v=c1ea034f"></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+g7ea979e
+                0.1.dev1+g9b7dc0c
               </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="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Welcome to OpenUpgrade Library’s documentation! &mdash; OpenUpgrade Library 0.1.dev1+g7ea979e documentation</title>
+  <title>Welcome to OpenUpgrade Library’s documentation! &mdash; OpenUpgrade Library 0.1.dev1+g9b7dc0c documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -13,7 +13,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=4c8ba79d"></script>
+        <script src="_static/documentation_options.js?v=c1ea034f"></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+g7ea979e
+                0.1.dev1+g9b7dc0c
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -183,6 +183,8 @@ <h1>Welcome to OpenUpgrade Library’s documentation!<a class="headerlink" href=
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="API.html#methods-for-openupgrade-16-0">Methods for OpenUpgrade 16.0</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="API.html#openupgradelib.openupgrade_160.convert_field_bootstrap_4to5"><code class="docutils literal notranslate"><span class="pre">convert_field_bootstrap_4to5()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="API.html#openupgradelib.openupgrade_160.convert_string_bootstrap_4to5"><code class="docutils literal notranslate"><span class="pre">convert_string_bootstrap_4to5()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="API.html#openupgradelib.openupgrade_160.migrate_translations_to_jsonb"><code class="docutils literal notranslate"><span class="pre">migrate_translations_to_jsonb()</span></code></a></li>
 </ul>
 </li>

diff --git a/docs/installation.html b/docs/installation.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Installation &mdash; OpenUpgrade Library 0.1.dev1+g7ea979e documentation</title>
+  <title>Installation &mdash; OpenUpgrade Library 0.1.dev1+g9b7dc0c documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -13,7 +13,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=4c8ba79d"></script>
+        <script src="_static/documentation_options.js?v=c1ea034f"></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>
@@ -35,7 +35,7 @@
             OpenUpgrade Library
           </a>
               <div class="version">
-                0.1.dev1+g7ea979e
+                0.1.dev1+g9b7dc0c
               </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+g7ea979e documentation</title>
+  <title>Python Module Index &mdash; OpenUpgrade Library 0.1.dev1+g9b7dc0c documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -12,7 +12,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=4c8ba79d"></script>
+        <script src="_static/documentation_options.js?v=c1ea034f"></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>
@@ -35,7 +35,7 @@
             OpenUpgrade Library
           </a>
               <div class="version">
-                0.1.dev1+g7ea979e
+                0.1.dev1+g9b7dc0c
               </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="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>OpenUpgrade Library &mdash; OpenUpgrade Library 0.1.dev1+g7ea979e documentation</title>
+  <title>OpenUpgrade Library &mdash; OpenUpgrade Library 0.1.dev1+g9b7dc0c documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -13,7 +13,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=4c8ba79d"></script>
+        <script src="_static/documentation_options.js?v=c1ea034f"></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>
@@ -35,7 +35,7 @@
             OpenUpgrade Library
           </a>
               <div class="version">
-                0.1.dev1+g7ea979e
+                0.1.dev1+g9b7dc0c
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">