[ADD] Simple OCA-style Readme to several modules (#114)

2020-03-18 15:55:42 +01:00
parent a545c8dbb6
commit e96c3d72eb
25 changed files with 1831 additions and 97 deletions
--- a/purchase_usability/README.rst
+++ b/purchase_usability/README.rst
@@ -0,0 +1,63 @@
+==================
+Purchase Usability
+==================
+
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-akretion%2Fodoo--usability-lightgray.png?logo=github
+    :target: https://github.com/akretion/odoo-usability/tree/12.0/purchase_usability
+    :alt: akretion/odoo-usability
+
+|badge1| |badge2| |badge3| 
+
+This module adds the following functions:
+ - Track visibility on partner and product purchase warning
+ - Track visibility on Purchase Order warning
+ - Methods to help generate py3o purchase reports
+ - Use untaxed amount in name_get of purchase orders
+ - Protect Cancel button with a confirmation pop-up
+ - Misc. improvements to Purchase Order Line views
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/akretion/odoo-usability/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us smashing it by providing a detailed and welcomed
+`feedback <https://github.com/akretion/odoo-usability/issues/new?body=module:%20purchase_usability%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+~~~~~~~
+
+* Akretion
+
+Contributors
+~~~~~~~~~~~~
+
+* Alexis de Lattre <alexis.delattre@akretion.com>
+
+Maintainers
+~~~~~~~~~~~
+
+This module is part of the `akretion/odoo-usability <https://github.com/akretion/odoo-usability/tree/12.0/purchase_usability>`_ project on GitHub.
+
+You are welcome to contribute.
--- a/purchase_usability/manifest.py
+++ b/purchase_usability/manifest.py
@@ -8,14 +8,6 @@
    'category': 'Purchases',
    'license': 'AGPL-3',
    'summary': 'Usability improvements on purchase module',
-    'description': """
-Purchase Usability
-==================
-
-Several usability improvements on the official purchase module:
-
-Please contact Alexis de Lattre from Akretion <alexis.delattre@akretion.com> for any help or question about this module.
-    """,
    'author': 'Akretion',
    'website': 'http://www.akretion.com',
    'depends': ['purchase'],
--- a/purchase_usability/readme/CONTRIBUTORS.rst
+++ b/purchase_usability/readme/CONTRIBUTORS.rst
@@ -0,0 +1 @@
+* Alexis de Lattre <alexis.delattre@akretion.com>
--- a/purchase_usability/readme/DESCRIPTION.rst
+++ b/purchase_usability/readme/DESCRIPTION.rst
@@ -0,0 +1,7 @@
+This module adds the following functions:
+ - Track visibility on partner and product purchase warning
+ - Track visibility on Purchase Order warning
+ - Methods to help generate py3o purchase reports
+ - Use untaxed amount in name_get of purchase orders
+ - Protect Cancel button with a confirmation pop-up
+ - Misc. improvements to Purchase Order Line views
--- a/purchase_usability/static/description/index.html
+++ b/purchase_usability/static/description/index.html
@@ -3,8 +3,8 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" />
-<title>MRP Usability</title>
+<meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" />
+<title>Purchase Usability</title>
 <style type="text/css">

 /*
@@ -360,22 +360,26 @@ ul.auto-toc {
 </style>
 </head>
 <body>
-<div class="document" id="mrp-usability">
-<h1 class="title">MRP Usability</h1>
+<div class="document" id="purchase-usability">
+<h1 class="title">Purchase Usability</h1>

 <!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! This file is generated by oca-gen-addon-readme !!
 !! changes will be overwritten.                   !!
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/akretion/odoo-usability/tree/12.0/mrp_usability"><img alt="akretion/odoo-usability" src="https://img.shields.io/badge/github-akretion%2Fodoo--usability-lightgray.png?logo=github" /></a></p>
-<p>Small usability improvements on MRP:</p>
-<ul class="simple">
-<li>order by id desc</li>
-<li>show field date_start and date_finished on mrp.production form view</li>
-<li>show more fields on stock move form</li>
-<li>show bom type in tree view + add group by</li>
-<li>complete Manufacturing Order report with unvailable products</li>
+<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/akretion/odoo-usability/tree/12.0/purchase_usability"><img alt="akretion/odoo-usability" src="https://img.shields.io/badge/github-akretion%2Fodoo--usability-lightgray.png?logo=github" /></a></p>
+<dl class="docutils">
+<dt>This module adds the following functions:</dt>
+<dd><ul class="first last simple">
+<li>Track visibility on partner and product purchase warning</li>
+<li>Track visibility on Purchase Order warning</li>
+<li>Methods to help generate py3o purchase reports</li>
+<li>Use untaxed amount in name_get of purchase orders</li>
+<li>Protect Cancel button with a confirmation pop-up</li>
+<li>Misc. improvements to Purchase Order Line views</li>
 </ul>
+</dd>
+</dl>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
@@ -393,7 +397,7 @@ ul.auto-toc {
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/akretion/odoo-usability/issues">GitHub Issues</a>.
 In case of trouble, please check there if your issue has already been reported.
 If you spotted it first, help us smashing it by providing a detailed and welcomed
-<a class="reference external" href="https://github.com/akretion/odoo-usability/issues/new?body=module:%20mrp_usability%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
+<a class="reference external" href="https://github.com/akretion/odoo-usability/issues/new?body=module:%20purchase_usability%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
 <p>Do not contact contributors directly about support or help with technical issues.</p>
 </div>
 <div class="section" id="credits">
@@ -406,11 +410,13 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
 </div>
 <div class="section" id="contributors">
 <h2><a class="toc-backref" href="#id4">Contributors</a></h2>
-<p>Alexis de Lattre &lt;<a class="reference external" href="mailto:alexis.delattre&#64;akretion.com">alexis.delattre&#64;akretion.com</a>&gt;</p>
+<ul class="simple">
+<li>Alexis de Lattre &lt;<a class="reference external" href="mailto:alexis.delattre&#64;akretion.com">alexis.delattre&#64;akretion.com</a>&gt;</li>
+</ul>
 </div>
 <div class="section" id="maintainers">
 <h2><a class="toc-backref" href="#id5">Maintainers</a></h2>
-<p>This module is part of the <a class="reference external" href="https://github.com/akretion/odoo-usability/tree/12.0/mrp_usability">akretion/odoo-usability</a> project on GitHub.</p>
+<p>This module is part of the <a class="reference external" href="https://github.com/akretion/odoo-usability/tree/12.0/purchase_usability">akretion/odoo-usability</a> project on GitHub.</p>
 <p>You are welcome to contribute.</p>
 </div>
 </div>
				`@@ -0,0 +1 @@`
				`* Alexis de Lattre <alexis.delattre@akretion.com>`