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 18, 2022
1 parent c4946bb commit 9178aa8
Show file tree
Hide file tree
Showing 35 changed files with 469 additions and 388 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: 74010af76e10829a51fc5aaedfbdafd4
config: a95a91d02999b609679bad5285604a80
tags: 645f666f9bcd5a90fca523b33c5a78b7
25 changes: 24 additions & 1 deletion docs/API.html
Original file line number Diff line number Diff line change
Expand Up @@ -550,6 +550,18 @@ <h1>OpenUpgrade API<a class="headerlink" href="#openupgrade-api" title="Permalin
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="openupgradelib.openupgrade.merge_models">
<span class="sig-prename descclassname"><span class="pre">openupgradelib.openupgrade.</span></span><span class="sig-name descname"><span class="pre">merge_models</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">old_model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref_field</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openupgradelib.openupgrade.merge_models" title="Permalink to this definition"></a></dt>
<dd><p>Update model references for models that have merged to an existing model.
:param old_model: old model
:param new_model: destination model
:param ref_field: name of the field in new model that references
the id of the old model. Usually created before calling this method.</p>
<p>WARNING: This method doesn’t move the records from old_model to new_model
tables. You should have to do that previously in the migration scripts.</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="openupgradelib.openupgrade.message">
<span class="sig-prename descclassname"><span class="pre">openupgradelib.openupgrade.</span></span><span class="sig-name descname"><span class="pre">message</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</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>, <em class="sig-param"><span class="n"><span class="pre">message</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openupgradelib.openupgrade.message" title="Permalink to this definition"></a></dt>
Expand Down Expand Up @@ -842,6 +854,17 @@ <h1>OpenUpgrade API<a class="headerlink" href="#openupgrade-api" title="Permalin
</dl>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="openupgradelib.openupgrade.update_module_moved_models">
<span class="sig-prename descclassname"><span class="pre">openupgradelib.openupgrade.</span></span><span class="sig-name descname"><span class="pre">update_module_moved_models</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">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">old_module</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_module</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openupgradelib.openupgrade.update_module_moved_models" title="Permalink to this definition"></a></dt>
<dd><p>Update module for model definition in general tables that have been
moved from one module to another.
:param cr: Database cursor
:param model: Model name
:param old_module: Previous module of the models
:param new_module: New module of the models</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="openupgradelib.openupgrade.update_module_names">
<span class="sig-prename descclassname"><span class="pre">openupgradelib.openupgrade.</span></span><span class="sig-name descname"><span class="pre">update_module_names</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">namespec</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">merge_modules</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openupgradelib.openupgrade.update_module_names" title="Permalink to this definition"></a></dt>
Expand Down Expand Up @@ -1123,7 +1146,7 @@ <h3 id="searchlabel">Quick search</h3>
&copy;2012-2021, Odoo Community Association (OCA) / The OpenUpgrade developers.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.5.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

|
Expand Down
72 changes: 52 additions & 20 deletions docs/_static/doctools.js
Original file line number Diff line number Diff line change
Expand Up @@ -154,9 +154,7 @@ var Documentation = {
this.fixFirefoxAnchorBug();
this.highlightSearchWords();
this.initIndexTable();
if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {
this.initOnKeyListeners();
}
this.initOnKeyListeners();
},

/**
Expand Down Expand Up @@ -269,6 +267,13 @@ var Documentation = {
window.history.replaceState({}, '', url);
},

/**
* helper function to focus on search bar
*/
focusSearchBar : function() {
$('input[name=q]').first().focus();
},

/**
* make the url absolute
*/
Expand All @@ -291,27 +296,54 @@ var Documentation = {
},

initOnKeyListeners: function() {
// only install a listener if it is really needed
if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS)
return;

$(document).keydown(function(event) {
var activeElementType = document.activeElement.tagName;
// don't navigate when in search box, textarea, dropdown or button
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
&& activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey
&& !event.shiftKey) {
switch (event.keyCode) {
case 37: // left
var prevHref = $('link[rel="prev"]').prop('href');
if (prevHref) {
window.location.href = prevHref;
return false;
}
break;
case 39: // right
var nextHref = $('link[rel="next"]').prop('href');
if (nextHref) {
window.location.href = nextHref;
return false;
}
break;
&& activeElementType !== 'BUTTON') {
if (event.altKey || event.ctrlKey || event.metaKey)
return;

if (!event.shiftKey) {
switch (event.key) {
case 'ArrowLeft':
if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS)
break;
var prevHref = $('link[rel="prev"]').prop('href');
if (prevHref) {
window.location.href = prevHref;
return false;
}
break;
case 'ArrowRight':
if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS)
break;
var nextHref = $('link[rel="next"]').prop('href');
if (nextHref) {
window.location.href = nextHref;
return false;
}
break;
case 'Escape':
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS)
break;
Documentation.hideSearchWords();
return false;
}
}

// some keyboard layouts may need Shift to get /
switch (event.key) {
case '/':
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS)
break;
Documentation.focusSearchBar();
return false;
}
}
});
Expand Down
4 changes: 3 additions & 1 deletion docs/_static/documentation_options.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,7 @@ var DOCUMENTATION_OPTIONS = {
LINK_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt',
NAVIGATION_WITH_KEYS: false
NAVIGATION_WITH_KEYS: false,
SHOW_SEARCH_SUMMARY: true,
ENABLE_SEARCH_SHORTCUTS: true,
};
8 changes: 2 additions & 6 deletions docs/_static/searchtools.js
Original file line number Diff line number Diff line change
Expand Up @@ -172,10 +172,6 @@ var Search = {
}
// stem the word
var word = stemmer.stemWord(tmp[i].toLowerCase());
// prevent stemmer from cutting word smaller than two chars
if(word.length < 3 && tmp[i].length >= 3) {
word = tmp[i];
}
var toAppend;
// select the correct list
if (word[0] == '-') {
Expand Down Expand Up @@ -276,7 +272,7 @@ var Search = {
setTimeout(function() {
displayNextItem();
}, 5);
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
} else if (DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY) {
$.ajax({url: requestUrl,
dataType: "text",
complete: function(jqxhr, textstatus) {
Expand All @@ -293,7 +289,7 @@ var Search = {
}, 5);
}});
} else {
// no source available, just display title
// just display title
Search.output.append(listItem);
setTimeout(function() {
displayNextItem();
Expand Down
2 changes: 1 addition & 1 deletion docs/after_migration.html
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ <h3 id="searchlabel">Quick search</h3>
&copy;2012-2021, Odoo Community Association (OCA) / The OpenUpgrade developers.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.5.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

|
Expand Down
2 changes: 1 addition & 1 deletion docs/analyse.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ <h3 id="searchlabel">Quick search</h3>
&copy;2012-2021, Odoo Community Association (OCA) / The OpenUpgrade developers.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.5.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

|
Expand Down
2 changes: 1 addition & 1 deletion docs/analysis.html
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ <h3 id="searchlabel">Quick search</h3>
&copy;2012-2021, Odoo Community Association (OCA) / The OpenUpgrade developers.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.5.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

|
Expand Down
2 changes: 1 addition & 1 deletion docs/community.html
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ <h3 id="searchlabel">Quick search</h3>
&copy;2012-2021, Odoo Community Association (OCA) / The OpenUpgrade developers.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.5.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

|
Expand Down
2 changes: 1 addition & 1 deletion docs/coverage_legend.html
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ <h3 id="searchlabel">Quick search</h3>
&copy;2012-2021, Odoo Community Association (OCA) / The OpenUpgrade developers.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.5.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

|
Expand Down
2 changes: 1 addition & 1 deletion docs/development.html
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ <h3 id="searchlabel">Quick search</h3>
&copy;2012-2021, Odoo Community Association (OCA) / The OpenUpgrade developers.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.5.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

|
Expand Down
2 changes: 1 addition & 1 deletion docs/devfaq.html
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ <h3 id="searchlabel">Quick search</h3>
&copy;2012-2021, Odoo Community Association (OCA) / The OpenUpgrade developers.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.5.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

|
Expand Down
2 changes: 1 addition & 1 deletion docs/format.html
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ <h3 id="searchlabel">Quick search</h3>
&copy;2012-2021, Odoo Community Association (OCA) / The OpenUpgrade developers.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.5.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

|
Expand Down
12 changes: 8 additions & 4 deletions docs/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -157,11 +157,15 @@ <h2 id="M">M</h2>
<li><a href="API.html#openupgradelib.openupgrade.m2o_to_x2m">m2o_to_x2m() (in module openupgradelib.openupgrade)</a>
</li>
<li><a href="API.html#openupgradelib.openupgrade.map_values">map_values() (in module openupgradelib.openupgrade)</a>
</li>
<li><a href="API.html#openupgradelib.openupgrade.merge_models">merge_models() (in module openupgradelib.openupgrade)</a>
</li>
<li><a href="API.html#openupgradelib.openupgrade.message">message() (in module openupgradelib.openupgrade)</a>
</li>
<li><a href="API.html#openupgradelib.openupgrade.migrate">migrate() (in module openupgradelib.openupgrade)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
module

Expand All @@ -175,8 +179,6 @@ <h2 id="M">M</h2>
<li><a href="API.html#module-openupgradelib.openupgrade_90">openupgradelib.openupgrade_90</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="API.html#openupgradelib.openupgrade.move_field_m2o">move_field_m2o() (in module openupgradelib.openupgrade)</a>
</li>
</ul></td>
Expand Down Expand Up @@ -276,10 +278,12 @@ <h2 id="U">U</h2>
<li><a href="API.html#openupgradelib.openupgrade_80.update_aliases">update_aliases() (in module openupgradelib.openupgrade_80)</a>
</li>
<li><a href="API.html#openupgradelib.openupgrade.update_field_multilang">update_field_multilang() (in module openupgradelib.openupgrade)</a>
</li>
<li><a href="API.html#openupgradelib.openupgrade.update_module_moved_fields">update_module_moved_fields() (in module openupgradelib.openupgrade)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="API.html#openupgradelib.openupgrade.update_module_moved_fields">update_module_moved_fields() (in module openupgradelib.openupgrade)</a>
<li><a href="API.html#openupgradelib.openupgrade.update_module_moved_models">update_module_moved_models() (in module openupgradelib.openupgrade)</a>
</li>
<li><a href="API.html#openupgradelib.openupgrade.update_module_names">update_module_names() (in module openupgradelib.openupgrade)</a>
</li>
Expand Down Expand Up @@ -357,7 +361,7 @@ <h3 id="searchlabel">Quick search</h3>
&copy;2012-2021, Odoo Community Association (OCA) / The OpenUpgrade developers.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.5.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ <h3 id="searchlabel">Quick search</h3>
&copy;2012-2021, Odoo Community Association (OCA) / The OpenUpgrade developers.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.5.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

|
Expand Down
2 changes: 1 addition & 1 deletion docs/intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ <h3 id="searchlabel">Quick search</h3>
&copy;2012-2021, Odoo Community Association (OCA) / The OpenUpgrade developers.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.5.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

|
Expand Down
2 changes: 1 addition & 1 deletion docs/migration_details.html
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ <h3 id="searchlabel">Quick search</h3>
&copy;2012-2021, Odoo Community Association (OCA) / The OpenUpgrade developers.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.5.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

|
Expand Down
2 changes: 1 addition & 1 deletion docs/migrationmanager.html
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ <h3 id="searchlabel">Quick search</h3>
&copy;2012-2021, Odoo Community Association (OCA) / The OpenUpgrade developers.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.5.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

|
Expand Down
10 changes: 5 additions & 5 deletions docs/modules100-110.html
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ <h1>Module coverage 10.0 -&gt; 11.0<a class="headerlink" href="#module-coverage-
<td><p>Done</p></td>
</tr>
<tr class="row-odd"><td><p>hr_maintenance</p></td>
<td></td>
<td><p>Nothing to do</p></td>
</tr>
<tr class="row-even"><td><p><img alt="new" src="_images/new.png" /> hr_org_chart</p></td>
<td></td>
Expand Down Expand Up @@ -496,7 +496,7 @@ <h1>Module coverage 10.0 -&gt; 11.0<a class="headerlink" href="#module-coverage-
<td></td>
</tr>
<tr class="row-even"><td><p>l10n_pt</p></td>
<td></td>
<td><p>Done</p></td>
</tr>
<tr class="row-odd"><td><p>l10n_ro</p></td>
<td></td>
Expand Down Expand Up @@ -544,7 +544,7 @@ <h1>Module coverage 10.0 -&gt; 11.0<a class="headerlink" href="#module-coverage-
<td><p>Done</p></td>
</tr>
<tr class="row-even"><td><p>maintenance</p></td>
<td></td>
<td><p>Nothing to do</p></td>
</tr>
<tr class="row-odd"><td><p><img alt="del" src="_images/deleted.png" /> marketing_campaign</p></td>
<td></td>
Expand All @@ -568,7 +568,7 @@ <h1>Module coverage 10.0 -&gt; 11.0<a class="headerlink" href="#module-coverage-
<td><p>Done</p></td>
</tr>
<tr class="row-even"><td><p>mrp_byproduct</p></td>
<td></td>
<td><p>Nothing to do</p></td>
</tr>
<tr class="row-odd"><td><p>mrp_repair</p></td>
<td><p>Done</p></td>
Expand Down Expand Up @@ -1058,7 +1058,7 @@ <h3 id="searchlabel">Quick search</h3>
&copy;2012-2021, Odoo Community Association (OCA) / The OpenUpgrade developers.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.5.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

|
Expand Down
Loading

0 comments on commit 9178aa8

Please sign in to comment.