Skip to content

Commit

Permalink
[UPD] HTML documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed May 15, 2024
1 parent dfad8f2 commit 6a87c06
Show file tree
Hide file tree
Showing 21 changed files with 172 additions and 126 deletions.
2 changes: 1 addition & 1 deletion docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -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: b6e16aeeb3e0c0737ca9de2cec8dfd0a
config: 1fef2cc21159d253d790152cce3cfc1d
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/.doctrees/API.doctree
Binary file not shown.
Binary file modified docs/.doctrees/environment.pickle
Binary file not shown.
39 changes: 20 additions & 19 deletions docs/API.html
Original file line number Diff line number Diff line change
Expand Up @@ -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+gb7c0114 documentation</title>
<title>OpenUpgrade API &mdash; OpenUpgrade Library 0.1.dev1+gdfad8f2 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" />

Expand All @@ -15,8 +15,8 @@

<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=6c3b8e75"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/documentation_options.js?v=c21573c7"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
Expand All @@ -37,7 +37,7 @@
OpenUpgrade Library
</a>
<div class="version">
0.1.dev1+gb7c0114
0.1.dev1+gdfad8f2
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down Expand Up @@ -273,7 +273,7 @@ <h1>OpenUpgrade API<a class="headerlink" href="#openupgrade-api" title="Link to
If yes, return True.</p>
</div></blockquote>
<div class="versionadded">
<p><span class="versionmodified added">New in version 8.0.</span></p>
<p><span class="versionmodified added">Added in version 8.0.</span></p>
</div>
</dd></dl>

Expand Down Expand Up @@ -310,7 +310,7 @@ <h1>OpenUpgrade API<a class="headerlink" href="#openupgrade-api" title="Link to
<span class="sig-prename descclassname"><span class="pre">openupgradelib.openupgrade.</span></span><span class="sig-name descname"><span class="pre">convert_field_to_html</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">field_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">html_field_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</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.convert_field_to_html" title="Link to this definition"></a></dt>
<dd><p>Convert field value to HTML value.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 7.0.</span></p>
<p><span class="versionmodified added">Added in version 7.0.</span></p>
</div>
</dd></dl>

Expand Down Expand Up @@ -355,7 +355,7 @@ <h1>OpenUpgrade API<a class="headerlink" href="#openupgrade-api" title="Link to
</dd>
</dl>
<div class="versionadded">
<p><span class="versionmodified added">New in version 8.0.</span></p>
<p><span class="versionmodified added">Added in version 8.0.</span></p>
</div>
</dd></dl>

Expand Down Expand Up @@ -389,7 +389,7 @@ <h1>OpenUpgrade API<a class="headerlink" href="#openupgrade-api" title="Link to
</dd>
</dl>
<div class="versionadded">
<p><span class="versionmodified added">New in version 12.0.</span></p>
<p><span class="versionmodified added">Added in version 12.0.</span></p>
</div>
</dd></dl>

Expand Down Expand Up @@ -432,7 +432,7 @@ <h1>OpenUpgrade API<a class="headerlink" href="#openupgrade-api" title="Link to
:param date_field_name : The name of the old date field; (Typically a legacy name, set in pre-migration script)
:param datetime_field_name : The name of the new date field;</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 8.0.</span></p>
<p><span class="versionmodified added">Added in version 8.0.</span></p>
</div>
</dd></dl>

Expand All @@ -452,7 +452,7 @@ <h1>OpenUpgrade API<a class="headerlink" href="#openupgrade-api" title="Link to
</dd>
</dl>
<div class="versionadded">
<p><span class="versionmodified added">New in version 7.0.</span></p>
<p><span class="versionmodified added">Added in version 7.0.</span></p>
</div>
</dd></dl>

Expand Down Expand Up @@ -561,7 +561,7 @@ <h1>OpenUpgrade API<a class="headerlink" href="#openupgrade-api" title="Link to
</dd>
</dl>
<div class="versionadded">
<p><span class="versionmodified added">New in version 8.0.</span></p>
<p><span class="versionmodified added">Added in version 8.0.</span></p>
</div>
</dd></dl>

Expand Down Expand Up @@ -592,7 +592,7 @@ <h1>OpenUpgrade API<a class="headerlink" href="#openupgrade-api" title="Link to

<dl class="py function">
<dt class="sig sig-object py" id="openupgradelib.openupgrade.load_data">
<span class="sig-prename descclassname"><span class="pre">openupgradelib.openupgrade.</span></span><span class="sig-name descname"><span class="pre">load_data</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">module_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">idref</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">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'init'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openupgradelib.openupgrade.load_data" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">openupgradelib.openupgrade.</span></span><span class="sig-name descname"><span class="pre">load_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">env_or_cr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">idref</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">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'init'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openupgradelib.openupgrade.load_data" title="Link to this definition"></a></dt>
<dd><p>Load an xml, csv or yml data file from your post script. The usual case for
this is the
occurrence of newly added essential or useful data in the module that is
Expand All @@ -606,6 +606,7 @@ <h1>OpenUpgrade API<a class="headerlink" href="#openupgrade-api" title="Link to
Leave it to the user to actually delete existing resources that are
marked with ‘noupdate’ (other named items will be deleted
automatically).</p>
<p>Notes: Argument “env_or_cr” is an cr until 16 and is an env is required since 17.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
Expand Down Expand Up @@ -700,7 +701,7 @@ <h1>OpenUpgrade API<a class="headerlink" href="#openupgrade-api" title="Link to
</dd>
</dl>
<div class="versionadded">
<p><span class="versionmodified added">New in version 8.0.</span></p>
<p><span class="versionmodified added">Added in version 8.0.</span></p>
</div>
</dd></dl>

Expand All @@ -726,7 +727,7 @@ <h1>OpenUpgrade API<a class="headerlink" href="#openupgrade-api" title="Link to
</dl>
<p>This method does not support mapping m2m, o2m or property fields. For o2m you can migrate the inverse field’s column instead.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 8.0.</span></p>
<p><span class="versionmodified added">Added in version 8.0.</span></p>
</div>
</dd></dl>

Expand Down Expand Up @@ -757,7 +758,7 @@ <h1>OpenUpgrade API<a class="headerlink" href="#openupgrade-api" title="Link to
</dd>
</dl>
<div class="versionadded">
<p><span class="versionmodified added">New in version 7.0.</span></p>
<p><span class="versionmodified added">Added in version 7.0.</span></p>
</div>
</dd></dl>

Expand Down Expand Up @@ -798,7 +799,7 @@ <h1>OpenUpgrade API<a class="headerlink" href="#openupgrade-api" title="Link to
:param quick_request: Set to False, if you want to use write function to update value; Otherwise, the function will use UPDATE SQL request;
:param compute_func: This a function that receives 4 parameters: cr, pool: common args; id: id of the instance of Model B vals: list of different values. This function must return a unique value that will be set to the instance of Model B which id is ‘id’ param; If compute_func is not set, the algorithm will take the value that is the most present in vals. :binary_field: Set to True if the migrated field is a binary field</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 8.0.</span></p>
<p><span class="versionmodified added">Added in version 8.0.</span></p>
</div>
</dd></dl>

Expand All @@ -813,7 +814,7 @@ <h1>OpenUpgrade API<a class="headerlink" href="#openupgrade-api" title="Link to
</dd>
</dl>
<div class="versionadded">
<p><span class="versionmodified added">New in version 7.0.</span></p>
<p><span class="versionmodified added">Added in version 7.0.</span></p>
</div>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 11.0: </span>Workflows were removed from Odoo as of version 11.0</p>
Expand Down Expand Up @@ -1080,7 +1081,7 @@ <h1>OpenUpgrade API<a class="headerlink" href="#openupgrade-api" title="Link to
</dd>
</dl>
<div class="versionadded">
<p><span class="versionmodified added">New in version 7.0.</span></p>
<p><span class="versionmodified added">Added in version 7.0.</span></p>
</div>
</dd></dl>

Expand All @@ -1105,7 +1106,7 @@ <h1>OpenUpgrade API<a class="headerlink" href="#openupgrade-api" title="Link to
</dd>
</dl>
<div class="versionadded">
<p><span class="versionmodified added">New in version 7.0.</span></p>
<p><span class="versionmodified added">Added in version 7.0.</span></p>
</div>
</dd></dl>

Expand Down
2 changes: 1 addition & 1 deletion docs/_static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down
2 changes: 1 addition & 1 deletion docs/_static/doctools.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Base JavaScript utilities for all Sphinx HTML documentation.
*
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down
2 changes: 1 addition & 1 deletion docs/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '0.1.dev1+gb7c0114',
VERSION: '0.1.dev1+gdfad8f2',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
4 changes: 2 additions & 2 deletions docs/_static/language_data.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
* This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter.
*
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/

var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];


/* Non-minified version is copied as a separate JS file, is available */
/* Non-minified version is copied as a separate JS file, if available */

/**
* Porter Stemmer
Expand Down
Loading

0 comments on commit 6a87c06

Please sign in to comment.