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 Mar 14, 2023
1 parent e3a5c23 commit 1f8a1bd
Show file tree
Hide file tree
Showing 37 changed files with 886 additions and 975 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: e4c455374ef652602fa33c3b80e77422
config: 823c91a8de4b31c24085e717ef65304b
tags: 645f666f9bcd5a90fca523b33c5a78b7
116 changes: 57 additions & 59 deletions docs/API.html

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion docs/_static/alabaster.css
Original file line number Diff line number Diff line change
Expand Up @@ -419,7 +419,9 @@ table.footnote td {
}

dl {
margin: 0;
margin-left: 0;
margin-right: 0;
margin-top: 0;
padding: 0;
}

Expand Down
52 changes: 28 additions & 24 deletions 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-2022 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down Expand Up @@ -236,16 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote {
a.headerlink {
visibility: hidden;
}
a.brackets:before,
span.brackets > a:before{
content: "[";
}

a.brackets:after,
span.brackets > a:after {
content: "]";
}


h1:hover > a.headerlink,
h2:hover > a.headerlink,
Expand Down Expand Up @@ -334,11 +324,17 @@ aside.sidebar {
p.sidebar-title {
font-weight: bold;
}

nav.contents,
aside.topic,
div.admonition, div.topic, blockquote {
clear: left;
}

/* -- topics ---------------------------------------------------------------- */

nav.contents,
aside.topic,
div.topic {
border: 1px solid #ccc;
padding: 7px;
Expand Down Expand Up @@ -377,13 +373,17 @@ div.body p.centered {

div.sidebar > :last-child,
aside.sidebar > :last-child,
nav.contents > :last-child,
aside.topic > :last-child,
div.topic > :last-child,
div.admonition > :last-child {
margin-bottom: 0;
}

div.sidebar::after,
aside.sidebar::after,
nav.contents::after,
aside.topic::after,
div.topic::after,
div.admonition::after,
blockquote::after {
Expand Down Expand Up @@ -608,19 +608,27 @@ ol.simple p,
ul.simple p {
margin-bottom: 0;
}
dl.footnote > dt,
dl.citation > dt {

aside.footnote > span,
div.citation > span {
float: left;
margin-right: 0.5em;
}

dl.footnote > dd,
dl.citation > dd {
aside.footnote > span:last-of-type,
div.citation > span:last-of-type {
padding-right: 0.5em;
}
aside.footnote > p {
margin-left: 2em;
}
div.citation > p {
margin-left: 4em;
}
aside.footnote > p:last-of-type,
div.citation > p:last-of-type {
margin-bottom: 0em;
}

dl.footnote > dd:after,
dl.citation > dd:after {
aside.footnote > p:last-of-type:after,
div.citation > p:last-of-type:after {
content: "";
clear: both;
}
Expand All @@ -636,10 +644,6 @@ dl.field-list > dt {
padding-left: 0.5em;
padding-right: 5px;
}
dl.field-list > dt:after {
content: ":";
}


dl.field-list > dd {
padding-left: 0.5em;
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-2022 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down
2 changes: 1 addition & 1 deletion docs/_static/language_data.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter.
*
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down
2 changes: 1 addition & 1 deletion docs/_static/searchtools.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for the full-text search.
*
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down
14 changes: 6 additions & 8 deletions docs/after_migration.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,12 @@
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<title>After migration &#8212; OpenUpgrade 16.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<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" />
Expand All @@ -34,7 +32,7 @@

<div class="body" role="main">

<div class="section" id="after-migration">
<section id="after-migration">
<h1>After migration<a class="headerlink" href="#after-migration" title="Permalink to this heading"></a></h1>
<p>OpenUpgrade keeps old model tables and old columns (prefixed with
<cite>openupgrade_legacy_</cite> word) in PostgreSQL as a conservative strategy because
Expand All @@ -51,7 +49,7 @@ <h1>After migration<a class="headerlink" href="#after-migration" title="Permalin
an intuitive way.</p>
<p>You are also encouraged to have Postgresql run a full vacuum to free up disk
space (see the documentation of your version of Postgresql).</p>
</div>
</section>


</div>
Expand Down Expand Up @@ -121,8 +119,8 @@ <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 5.3.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 6.1.3</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>

|
<a href="_sources/after_migration.rst.txt"
Expand Down
14 changes: 6 additions & 8 deletions docs/analyse.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,12 @@
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<title>How to run your own analysis &#8212; OpenUpgrade 16.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<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" />
Expand All @@ -34,7 +32,7 @@

<div class="body" role="main">

<div class="section" id="how-to-run-your-own-analysis">
<section id="how-to-run-your-own-analysis">
<h1>How to run your own analysis<a class="headerlink" href="#how-to-run-your-own-analysis" title="Permalink to this heading"></a></h1>
<p>If you do need to run your own analysis, you need to perform the following
steps.</p>
Expand Down Expand Up @@ -68,7 +66,7 @@ <h1>How to run your own analysis<a class="headerlink" href="#how-to-run-your-own
<li><p>In the case of OCA or custom modules: in the <cite>migrations/&lt;version&gt;</cite>
directory in the module directory itself.</p></li>
</ul>
</div>
</section>


</div>
Expand Down Expand Up @@ -143,8 +141,8 @@ <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 5.3.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 6.1.3</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>

|
<a href="_sources/analyse.rst.txt"
Expand Down
22 changes: 10 additions & 12 deletions docs/analysis.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,12 @@
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<title>Database analysis &#8212; OpenUpgrade 16.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<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" />
Expand All @@ -34,22 +32,22 @@

<div class="body" role="main">

<div class="section" id="database-analysis">
<section id="database-analysis">
<h1>Database analysis<a class="headerlink" href="#database-analysis" title="Permalink to this heading"></a></h1>
<p>Database analysis files are hosted in <cite>scripts</cite> subdirectory of the
openupgrade_scripts module directory in the <a class="reference external" href="https://github.com/oca/openupgrade">https://github.com/oca/openupgrade</a>
repository.</p>
<p>You can create a custom set of analysis files on any set of modules between
any two versions of Odoo using the <cite>upgrade_analysis</cite> module that is hosted
in <a class="reference external" href="https://github.com/oca/server-tools">https://github.com/oca/server-tools</a>.</p>
<div class="section" id="earlier-versions">
<section id="earlier-versions">
<h2>Earlier versions<a class="headerlink" href="#earlier-versions" title="Permalink to this heading"></a></h2>
<p>In editions earlier than 14.0, the analysis files were hosted in the forks of
Odoo at <a class="reference external" href="https://github.com/oca/openupgrade">https://github.com/oca/openupgrade</a>. The module to create the analysis
was placed in each branch of the openupgrade repository under
odoo/addons/openupgrade_records.</p>
</div>
<div class="section" id="contents">
</section>
<section id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
<p>The contents of the migration directory per module are:</p>
<ul class="simple">
Expand Down Expand Up @@ -79,8 +77,8 @@ <h2>Contents<a class="headerlink" href="#contents" title="Permalink to this head
<li class="toctree-l1"><a class="reference internal" href="format.html">Fields analysis format</a></li>
</ul>
</div>
</div>
</div>
</section>
</section>


</div>
Expand Down Expand Up @@ -153,8 +151,8 @@ <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 5.3.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 6.1.3</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>

|
<a href="_sources/analysis.rst.txt"
Expand Down
14 changes: 6 additions & 8 deletions docs/community.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,12 @@
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<title>Community involvement &#8212; OpenUpgrade 16.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<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" />
Expand All @@ -34,7 +32,7 @@

<div class="body" role="main">

<div class="section" id="community-involvement">
<section id="community-involvement">
<h1>Community involvement<a class="headerlink" href="#community-involvement" title="Permalink to this heading"></a></h1>
<p>Writing migration scripts for Odoo is a lot of work, that can not be
accomplished by a single party. We need your help.</p>
Expand All @@ -57,7 +55,7 @@ <h1>Community involvement<a class="headerlink" href="#community-involvement" tit
project covers the modules that you have in use, try and use the software
to upgrade a copy of your database and give us feedback.</p>
<p>Thank you!</p>
</div>
</section>


</div>
Expand Down Expand Up @@ -121,8 +119,8 @@ <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 5.3.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 6.1.3</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>

|
<a href="_sources/community.rst.txt"
Expand Down
10 changes: 4 additions & 6 deletions docs/coverage_legend.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,12 @@
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<title>&lt;no title&gt; &#8212; OpenUpgrade 16.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<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" />
Expand Down Expand Up @@ -106,8 +104,8 @@ <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 5.3.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 6.1.3</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>

|
<a href="_sources/coverage_legend.rst.txt"
Expand Down
Loading

0 comments on commit 1f8a1bd

Please sign in to comment.