Merge pull request #103 from kmee/15.0-imp-readme

[15.0][IMP] Improves the readmes of various modules.

account_back2draft_security/README.rst

@@ -71,6 +71,13 @@ Contributors
 
    -  Bruno Corredato Botti
 
+Other credits
+-------------
+
+The development of this module has been financially supported by:
+
+-  `KMEE <https://kmee.com.br/>`__
+
 Maintainers
 -----------
 

account_back2draft_security/readme/CREDITS.md

@@ -0,0 +1,4 @@
+The development of this module has been financially supported by:
+
+- [KMEE](https://kmee.com.br/)
+

account_back2draft_security/static/description/index.html

@@ -380,7 +380,8 @@ <h1 class="title">Account Back2draft Security</h1>
 <li><a class="reference internal" href="#credits" id="toc-entry-4">Credits</a><ul>
 <li><a class="reference internal" href="#authors" id="toc-entry-5">Authors</a></li>
 <li><a class="reference internal" href="#contributors" id="toc-entry-6">Contributors</a></li>
-<li><a class="reference internal" href="#maintainers" id="toc-entry-7">Maintainers</a></li>
+<li><a class="reference internal" href="#other-credits" id="toc-entry-7">Other credits</a></li>
+<li><a class="reference internal" href="#maintainers" id="toc-entry-8">Maintainers</a></li>
 </ul>
 </li>
 </ul>
@@ -424,8 +425,15 @@ <h2><a class="toc-backref" href="#toc-entry-6">Contributors</a></h2>
 </li>
 </ul>
 </div>
+<div class="section" id="other-credits">
+<h2><a class="toc-backref" href="#toc-entry-7">Other credits</a></h2>
+<p>The development of this module has been financially supported by:</p>
+<ul class="simple">
+<li><a class="reference external" href="https://kmee.com.br/">KMEE</a></li>
+</ul>
+</div>
 <div class="section" id="maintainers">
-<h2><a class="toc-backref" href="#toc-entry-7">Maintainers</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-8">Maintainers</a></h2>
 <p>This module is part of the <a class="reference external" href="https://github.com/KMEE/kmee-odoo-addons/tree/15.0/account_back2draft_security">KMEE/kmee-odoo-addons</a> project on GitHub.</p>
 <p>You are welcome to contribute.</p>
 </div>

purchase_order_total_quantity/README.rst

@@ -61,6 +61,13 @@ Contributors
 
    -  Tiago Amaral
 
+Other credits
+-------------
+
+The development of this module has been financially supported by:
+
+-  `KMEE <https://kmee.com.br/>`__
+
 Maintainers
 -----------
 

purchase_order_total_quantity/readme/CREDITS.md

@@ -0,0 +1,4 @@
+The development of this module has been financially supported by:
+
+- [KMEE](https://kmee.com.br/)
+

purchase_order_total_quantity/static/description/index.html

@@ -380,7 +380,8 @@ <h1 class="title">Purchase Order Total Quantity</h1>
 <li><a class="reference internal" href="#credits" id="toc-entry-3">Credits</a><ul>
 <li><a class="reference internal" href="#authors" id="toc-entry-4">Authors</a></li>
 <li><a class="reference internal" href="#contributors" id="toc-entry-5">Contributors</a></li>
-<li><a class="reference internal" href="#maintainers" id="toc-entry-6">Maintainers</a></li>
+<li><a class="reference internal" href="#other-credits" id="toc-entry-6">Other credits</a></li>
+<li><a class="reference internal" href="#maintainers" id="toc-entry-7">Maintainers</a></li>
 </ul>
 </li>
 </ul>
@@ -415,8 +416,15 @@ <h2><a class="toc-backref" href="#toc-entry-5">Contributors</a></h2>
 </li>
 </ul>
 </div>
+<div class="section" id="other-credits">
+<h2><a class="toc-backref" href="#toc-entry-6">Other credits</a></h2>
+<p>The development of this module has been financially supported by:</p>
+<ul class="simple">
+<li><a class="reference external" href="https://kmee.com.br/">KMEE</a></li>
+</ul>
+</div>
 <div class="section" id="maintainers">
-<h2><a class="toc-backref" href="#toc-entry-6">Maintainers</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-7">Maintainers</a></h2>
 <p>This module is part of the <a class="reference external" href="https://github.com/KMEE/kmee-odoo-addons/tree/15.0/purchase_order_total_quantity">KMEE/kmee-odoo-addons</a> project on GitHub.</p>
 <p>You are welcome to contribute.</p>
 </div>

sale_order_pos_report/README.rst

@@ -29,13 +29,19 @@ POS report in a new browser tab.
 .. contents::
    :local:
 
+Use Cases / Context
+===================
+
+When printing a sales order report, some users prefer the PDF file to be
+opened in a separate tab for greater productivity.
+
 Usage
 =====
 
 To use this module, you need to:
 
-#. Go to *Sales > Orders > Quotation*. #. Within a sales order. Click
-the To **Print button**.
+1. Go to *Sales > Orders > Quotation*.
+2. Within a sales order. Click the To **Print button**.
 
 Bug Tracker
 ===========
@@ -62,6 +68,13 @@ Contributors
 
    -  Tiago Amaral
 
+Other credits
+-------------
+
+The development of this module has been financially supported by:
+
+-  `KMEE <https://kmee.com.br/>`__
+
 Maintainers
 -----------
 

sale_order_pos_report/readme/CONTEXT.md

@@ -0,0 +1,2 @@
+When printing a sales order report, some users prefer the PDF file to be opened in a separate tab for greater productivity.
+

sale_order_pos_report/readme/CREDITS.md

@@ -0,0 +1,3 @@
+The development of this module has been financially supported by:
+
+- [KMEE](https://kmee.com.br/)

sale_order_pos_report/readme/USAGE.md

@@ -1,4 +1,4 @@
 To use this module, you need to:
 
-#. Go to *Sales > Orders > Quotation*.
-#. Within a sales order. Click the To **Print button**.
+1. Go to *Sales > Orders > Quotation*.
+2. Within a sales order. Click the To **Print button**.

sale_order_pos_report/static/description/index.html

@@ -374,49 +374,65 @@ <h1 class="title">Sale Order Pos Report</h1>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
-<li><a class="reference internal" href="#usage" id="toc-entry-1">Usage</a></li>
-<li><a class="reference internal" href="#bug-tracker" id="toc-entry-2">Bug Tracker</a></li>
-<li><a class="reference internal" href="#credits" id="toc-entry-3">Credits</a><ul>
-<li><a class="reference internal" href="#authors" id="toc-entry-4">Authors</a></li>
-<li><a class="reference internal" href="#contributors" id="toc-entry-5">Contributors</a></li>
-<li><a class="reference internal" href="#maintainers" id="toc-entry-6">Maintainers</a></li>
+<li><a class="reference internal" href="#use-cases-context" id="toc-entry-1">Use Cases / Context</a></li>
+<li><a class="reference internal" href="#usage" id="toc-entry-2">Usage</a></li>
+<li><a class="reference internal" href="#bug-tracker" id="toc-entry-3">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="toc-entry-4">Credits</a><ul>
+<li><a class="reference internal" href="#authors" id="toc-entry-5">Authors</a></li>
+<li><a class="reference internal" href="#contributors" id="toc-entry-6">Contributors</a></li>
+<li><a class="reference internal" href="#other-credits" id="toc-entry-7">Other credits</a></li>
+<li><a class="reference internal" href="#maintainers" id="toc-entry-8">Maintainers</a></li>
 </ul>
 </li>
 </ul>
 </div>
+<div class="section" id="use-cases-context">
+<h1><a class="toc-backref" href="#toc-entry-1">Use Cases / Context</a></h1>
+<p>When printing a sales order report, some users prefer the PDF file to be
+opened in a separate tab for greater productivity.</p>
+</div>
 <div class="section" id="usage">
-<h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
 <p>To use this module, you need to:</p>
-<p>#. Go to <em>Sales &gt; Orders &gt; Quotation</em>. #. Within a sales order. Click
-the To <strong>Print button</strong>.</p>
+<ol class="arabic simple">
+<li>Go to <em>Sales &gt; Orders &gt; Quotation</em>.</li>
+<li>Within a sales order. Click the To <strong>Print button</strong>.</li>
+</ol>
 </div>
 <div class="section" id="bug-tracker">
-<h1><a class="toc-backref" href="#toc-entry-2">Bug Tracker</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-3">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/KMEE/kmee-odoo-addons/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 to smash it by providing a detailed and welcomed
 <a class="reference external" href="https://github.com/KMEE/kmee-odoo-addons/issues/new?body=module:%20sale_order_pos_report%0Aversion:%2015.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">
-<h1><a class="toc-backref" href="#toc-entry-3">Credits</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-4">Credits</a></h1>
 <div class="section" id="authors">
-<h2><a class="toc-backref" href="#toc-entry-4">Authors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-5">Authors</a></h2>
 <ul class="simple">
 <li>KMEE</li>
 </ul>
 </div>
 <div class="section" id="contributors">
-<h2><a class="toc-backref" href="#toc-entry-5">Contributors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-6">Contributors</a></h2>
 <ul class="simple">
 <li><tt class="docutils literal">KMEE <span class="pre">&lt;https://www.kmee.com.br&gt;</span></tt>_:<ul>
 <li>Tiago Amaral</li>
 </ul>
 </li>
 </ul>
 </div>
+<div class="section" id="other-credits">
+<h2><a class="toc-backref" href="#toc-entry-7">Other credits</a></h2>
+<p>The development of this module has been financially supported by:</p>
+<ul class="simple">
+<li><a class="reference external" href="https://kmee.com.br/">KMEE</a></li>
+</ul>
+</div>
 <div class="section" id="maintainers">
-<h2><a class="toc-backref" href="#toc-entry-6">Maintainers</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-8">Maintainers</a></h2>
 <p>This module is part of the <a class="reference external" href="https://github.com/KMEE/kmee-odoo-addons/tree/15.0/sale_order_pos_report">KMEE/kmee-odoo-addons</a> project on GitHub.</p>
 <p>You are welcome to contribute.</p>
 </div>

sale_order_pos_report_plain_text/README.rst

@@ -29,13 +29,19 @@ POS report containing unformatted text in a new browser tab.
 .. contents::
    :local:
 
+Use Cases / Context
+===================
+
+When printing a sales order report, some users prefer the PDF file to be
+opened in a separate tab for greater productivity.
+
 Usage
 =====
 
 To use this module, you need to:
 
-#. Go to *Sales > Orders > Quotation*. #. Within a sales order. Click
-the To **Print button**.
+1. Go to *Sales > Orders > Quotation*.
+2. Within a sales order. Click the To **Print button**.
 
 Bug Tracker
 ===========
@@ -62,6 +68,13 @@ Contributors
 
    -  Tiago Amaral
 
+Other credits
+-------------
+
+The development of this module has been financially supported by:
+
+-  `KMEE <https://kmee.com.br/>`__
+
 Maintainers
 -----------
 

sale_order_pos_report_plain_text/readme/CONTEXT.md

@@ -0,0 +1 @@
+When printing a sales order report, some users prefer the PDF file to be opened in a separate tab for greater productivity. 

sale_order_pos_report_plain_text/readme/CREDITS.md

@@ -0,0 +1,4 @@
+The development of this module has been financially supported by:
+
+- [KMEE](https://kmee.com.br/)
+

sale_order_pos_report_plain_text/readme/USAGE.md

@@ -1,4 +1,4 @@
 To use this module, you need to:
 
-#. Go to *Sales > Orders > Quotation*.
-#. Within a sales order. Click the To **Print button**.
+1. Go to *Sales > Orders > Quotation*.
+2. Within a sales order. Click the To **Print button**.

sale_order_pos_report_plain_text/static/description/index.html

@@ -374,49 +374,65 @@ <h1 class="title">Sale Order Pos Report</h1>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
-<li><a class="reference internal" href="#usage" id="toc-entry-1">Usage</a></li>
-<li><a class="reference internal" href="#bug-tracker" id="toc-entry-2">Bug Tracker</a></li>
-<li><a class="reference internal" href="#credits" id="toc-entry-3">Credits</a><ul>
-<li><a class="reference internal" href="#authors" id="toc-entry-4">Authors</a></li>
-<li><a class="reference internal" href="#contributors" id="toc-entry-5">Contributors</a></li>
-<li><a class="reference internal" href="#maintainers" id="toc-entry-6">Maintainers</a></li>
+<li><a class="reference internal" href="#use-cases-context" id="toc-entry-1">Use Cases / Context</a></li>
+<li><a class="reference internal" href="#usage" id="toc-entry-2">Usage</a></li>
+<li><a class="reference internal" href="#bug-tracker" id="toc-entry-3">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="toc-entry-4">Credits</a><ul>
+<li><a class="reference internal" href="#authors" id="toc-entry-5">Authors</a></li>
+<li><a class="reference internal" href="#contributors" id="toc-entry-6">Contributors</a></li>
+<li><a class="reference internal" href="#other-credits" id="toc-entry-7">Other credits</a></li>
+<li><a class="reference internal" href="#maintainers" id="toc-entry-8">Maintainers</a></li>
 </ul>
 </li>
 </ul>
 </div>
+<div class="section" id="use-cases-context">
+<h1><a class="toc-backref" href="#toc-entry-1">Use Cases / Context</a></h1>
+<p>When printing a sales order report, some users prefer the PDF file to be
+opened in a separate tab for greater productivity.</p>
+</div>
 <div class="section" id="usage">
-<h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
 <p>To use this module, you need to:</p>
-<p>#. Go to <em>Sales &gt; Orders &gt; Quotation</em>. #. Within a sales order. Click
-the To <strong>Print button</strong>.</p>
+<ol class="arabic simple">
+<li>Go to <em>Sales &gt; Orders &gt; Quotation</em>.</li>
+<li>Within a sales order. Click the To <strong>Print button</strong>.</li>
+</ol>
 </div>
 <div class="section" id="bug-tracker">
-<h1><a class="toc-backref" href="#toc-entry-2">Bug Tracker</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-3">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/KMEE/kmee-odoo-addons/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 to smash it by providing a detailed and welcomed
 <a class="reference external" href="https://github.com/KMEE/kmee-odoo-addons/issues/new?body=module:%20sale_order_pos_report_plain_text%0Aversion:%2015.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">
-<h1><a class="toc-backref" href="#toc-entry-3">Credits</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-4">Credits</a></h1>
 <div class="section" id="authors">
-<h2><a class="toc-backref" href="#toc-entry-4">Authors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-5">Authors</a></h2>
 <ul class="simple">
 <li>KMEE</li>
 </ul>
 </div>
 <div class="section" id="contributors">
-<h2><a class="toc-backref" href="#toc-entry-5">Contributors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-6">Contributors</a></h2>
 <ul class="simple">
 <li><tt class="docutils literal">KMEE <span class="pre">&lt;https://www.kmee.com.br&gt;</span></tt>_:<ul>
 <li>Tiago Amaral</li>
 </ul>
 </li>
 </ul>
 </div>
+<div class="section" id="other-credits">
+<h2><a class="toc-backref" href="#toc-entry-7">Other credits</a></h2>
+<p>The development of this module has been financially supported by:</p>
+<ul class="simple">
+<li><a class="reference external" href="https://kmee.com.br/">KMEE</a></li>
+</ul>
+</div>
 <div class="section" id="maintainers">
-<h2><a class="toc-backref" href="#toc-entry-6">Maintainers</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-8">Maintainers</a></h2>
 <p>This module is part of the <a class="reference external" href="https://github.com/KMEE/kmee-odoo-addons/tree/15.0/sale_order_pos_report_plain_text">KMEE/kmee-odoo-addons</a> project on GitHub.</p>
 <p>You are welcome to contribute.</p>
 </div>