[UPD] HTML documentation

OCA · May 15, 2023 · b62d887 · b62d887
1 parent 06e0b6a
commit b62d887
Show file tree

Hide file tree

Showing 55 changed files with 6,573 additions and 0 deletions.
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -0,0 +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: 2f4933f70ce9e299057ad5b7b2d85758
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.doctrees/API.doctree b/docs/.doctrees/API.doctree
diff --git a/docs/.doctrees/authors.doctree b/docs/.doctrees/authors.doctree
diff --git a/docs/.doctrees/contributing.doctree b/docs/.doctrees/contributing.doctree
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/history.doctree b/docs/.doctrees/history.doctree
diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree
diff --git a/docs/.doctrees/installation.doctree b/docs/.doctrees/installation.doctree
diff --git a/docs/.doctrees/readme.doctree b/docs/.doctrees/readme.doctree
diff --git a/docs/.doctrees/usage.doctree b/docs/.doctrees/usage.doctree
diff --git a/docs/API.html b/docs/API.html
@@ -0,0 +1,186 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <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+g06e0b6a 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]>
+    <script src="_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+        <script src="_static/doctools.js"></script>
+        <script src="_static/sphinx_highlight.js"></script>
+    <script src="_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="Contributing" href="contributing.html" />
+    <link rel="prev" title="Usage" href="usage.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="index.html" class="icon icon-home">
+            OpenUpgrade Library
+          </a>
+              <div class="version">
+                0.1.dev1+g06e0b6a
+              </div>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="readme.html">OpenUpgrade Library</a></li>
+<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">OpenUpgrade API</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#general-methods">General methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#methods-for-openupgrade-7-0">Methods for OpenUpgrade 7.0</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#methods-for-openupgrade-8-0">Methods for OpenUpgrade 8.0</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#methods-for-openupgrade-9-0">Methods for OpenUpgrade 9.0</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#methods-for-openupgrade-12-0">Methods for OpenUpgrade 12.0</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#methods-for-openupgrade-13-0">Methods for OpenUpgrade 13.0</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#methods-for-openupgrade-16-0">Methods for OpenUpgrade 16.0</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="authors.html">Credits</a></li>
+<li class="toctree-l1"><a class="reference internal" href="history.html">History</a></li>
+<li class="toctree-l1"><a class="reference internal" href="history.html#id1">3.0.0 (2019-09-16)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="history.html#id2">2.0.0 (2018-07-21)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="history.html#id3">1.3.1 (2017-09-01)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="history.html#id4">1.3.0 (2017-05-01)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="history.html#id5">1.2.2 (2016-12-27)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="history.html#id6">1.2.1 (2016-11-07)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="history.html#id7">1.2.0 (2016-10-10)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="history.html#id8">1.1.2 (2016-06-13)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="history.html#id9">1.1.1 (2015-10-30)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="history.html#id10">1.1.0 (2015-09-21)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="history.html#id11">1.0.0 (2015-08-10)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="history.html#id12">0.1.2 (2015-06-23)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="history.html#id13">0.1.1 (2015-05-05)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="history.html#id14">0.1.0 (2015-05-04)</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="index.html">OpenUpgrade Library</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">OpenUpgrade API</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <section id="openupgrade-api">
+<h1>OpenUpgrade API<a class="headerlink" href="#openupgrade-api" title="Permalink to this heading"></a></h1>
+<p>The OpenUpgrade library contains all kinds of helper functions for your pre and
+post scripts, in OpenUpgrade itself or in the migration scripts of your own
+module (in either major or minor version upgrades). It can be installed with</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>openupgradelib
+</pre></div>
+</div>
+<p>and then used in your scripts as</p>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">openupgradelib</span> <span class="kn">import</span> <span class="n">openupgrade</span>
+</pre></div>
+</div>
+<section id="general-methods">
+<h2>General methods<a class="headerlink" href="#general-methods" title="Permalink to this heading"></a></h2>
+</section>
+<section id="methods-for-openupgrade-7-0">
+<h2>Methods for OpenUpgrade 7.0<a class="headerlink" href="#methods-for-openupgrade-7-0" title="Permalink to this heading"></a></h2>
+<p>The following specific methods for 7.0 are available. These have been
+developed to cover specific needs as per data model changes in that
+release.</p>
+</section>
+<section id="methods-for-openupgrade-8-0">
+<h2>Methods for OpenUpgrade 8.0<a class="headerlink" href="#methods-for-openupgrade-8-0" title="Permalink to this heading"></a></h2>
+<p>The following specific methods for 8.0 are available. These have been
+developed to cover specific needs as per data model changes in that
+release.</p>
+</section>
+<section id="methods-for-openupgrade-9-0">
+<h2>Methods for OpenUpgrade 9.0<a class="headerlink" href="#methods-for-openupgrade-9-0" title="Permalink to this heading"></a></h2>
+<p>The following specific methods for 9.0 are available. These have been
+developed to cover specific needs as per data model changes in that
+release.</p>
+</section>
+<section id="methods-for-openupgrade-12-0">
+<h2>Methods for OpenUpgrade 12.0<a class="headerlink" href="#methods-for-openupgrade-12-0" title="Permalink to this heading"></a></h2>
+<p>The following specific methods for 12.0 are available. These have been
+developed to cover specific needs as per data model changes in that
+release.</p>
+</section>
+<section id="methods-for-openupgrade-13-0">
+<h2>Methods for OpenUpgrade 13.0<a class="headerlink" href="#methods-for-openupgrade-13-0" title="Permalink to this heading"></a></h2>
+<p>The following specific methods for 13.0 are available. These have been
+developed to cover specific needs as per data model changes in that
+release.</p>
+</section>
+<section id="methods-for-openupgrade-16-0">
+<h2>Methods for OpenUpgrade 16.0<a class="headerlink" href="#methods-for-openupgrade-16-0" title="Permalink to this heading"></a></h2>
+<p>The following specific methods for 16.0 are available. These have been
+developed to cover specific needs as per data model changes in that
+release.</p>
+</section>
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="usage.html" class="btn btn-neutral float-left" title="Usage" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="contributing.html" class="btn btn-neutral float-right" title="Contributing" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2015, Odoo Community Association.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>