Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[IMP] Improves the readmes of various modules. #104

Merged
merged 1 commit into from
Jan 26, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 15 additions & 81 deletions account_payment_currency_rate/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,91 +16,38 @@ Account Payment Currency Rate
.. |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-OCA%2Fkmee--odoo--addons-lightgray.png?logo=github
:target: https://github.com/OCA/kmee-odoo-addons/tree/16.0/account_payment_currency_rate
:alt: OCA/kmee-odoo-addons
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/kmee-odoo-addons-16-0/kmee-odoo-addons-16-0-account_payment_currency_rate
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/kmee-odoo-addons&target_branch=16.0
:alt: Try me on Runboat
.. |badge3| image:: https://img.shields.io/badge/github-KMEE%2Fkmee--odoo--addons-lightgray.png?logo=github
:target: https://github.com/KMEE/kmee-odoo-addons/tree/16.0/account_payment_currency_rate
:alt: KMEE/kmee-odoo-addons

|badge1| |badge2| |badge3| |badge4| |badge5|
|badge1| |badge2| |badge3|

[ This file must be max 2-3 paragraphs, and is required. ]
The module allows users to adjust the amount of a payment based on
exchange rate fluctuations, ensuring that exchange rate differences are
correctly recorded as profit or loss and automatically reconciled. This
improves accounting accuracy in international transactions, where
exchange rates may vary between the time of invoice and the time of
payment.

**Table of contents**

.. contents::
:local:

Use Cases / Context
===================

[ This file is optional but strongly suggested to allow end-users to
evaluate the module's usefulness in their context. ]

Installation
============

[ This file must only be present if there are very specific installation
instructions, such as installing non-python dependencies. The audience
is systems administrators. ]

To install this module, you need to:

1. Do nothing

Configuration
=============

[ This file is optional, it should explain how to configure the module
before using it; it is aimed at advanced users. ]

To configure this module, you need to:

1. Do nothing

Usage
=====

[ This file must be present and contains the usage instructions for
end-users. As all other rst files included in the README, it MUST NOT
contain reStructuredText sections only body text (paragraphs, lists,
tables, etc). Should you need a more elaborate structure to explain the
addon, please create a Sphinx documentation (which may include this file
as a "quick start" section). ]

To use this module, you need to:

1. Go to Invoice Payment Wizard and change the rate.

Changelog
=========

[ The change log. The goal of this file is to help readers understand
changes between version. The primary audience is end users and
integrators. Purely technical changes such as code refactoring must not
be mentioned here.

This file may contain ONE level of section titles, underlined with the ~
(tilde) character. Other section markers are forbidden and will likely
break the structure of the README.rst or other documents where this
fragment is included. ]

16.0.1.0.0 (2024-05-20)
-----------------------

- First Release

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/kmee-odoo-addons/issues>`_.
Bugs are tracked on `GitHub Issues <https://github.com/KMEE/kmee-odoo-addons/issues>`_.
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
`feedback <https://github.com/OCA/kmee-odoo-addons/issues/new?body=module:%20account_payment_currency_rate%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
`feedback <https://github.com/KMEE/kmee-odoo-addons/issues/new?body=module:%20account_payment_currency_rate%0Aversion:%2016.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.

Expand All @@ -120,26 +67,13 @@ Contributors
Other credits
-------------

[ This file is optional and contains additional credits, other than
authors, contributors, and maintainers. ]

The development of this module has been financially supported by:

- KMEE
- `KMEE <https://kmee.com.br/>`__

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org

OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

This module is part of the `OCA/kmee-odoo-addons <https://github.com/OCA/kmee-odoo-addons/tree/16.0/account_payment_currency_rate>`_ project on GitHub.
This module is part of the `KMEE/kmee-odoo-addons <https://github.com/KMEE/kmee-odoo-addons/tree/16.0/account_payment_currency_rate>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
You are welcome to contribute.
6 changes: 0 additions & 6 deletions account_payment_currency_rate/readme/CONFIGURE.md

This file was deleted.

2 changes: 0 additions & 2 deletions account_payment_currency_rate/readme/CONTEXT.md

This file was deleted.

6 changes: 2 additions & 4 deletions account_payment_currency_rate/readme/CREDITS.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
[ This file is optional and contains additional credits, other than
authors, contributors, and maintainers. ]

The development of this module has been financially supported by:

- KMEE
- [KMEE](https://kmee.com.br/)

2 changes: 1 addition & 1 deletion account_payment_currency_rate/readme/DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[ This file must be max 2-3 paragraphs, and is required. ]
The module allows users to adjust the amount of a payment based on exchange rate fluctuations, ensuring that exchange rate differences are correctly recorded as profit or loss and automatically reconciled. This improves accounting accuracy in international transactions, where exchange rates may vary between the time of invoice and the time of payment.
13 changes: 0 additions & 13 deletions account_payment_currency_rate/readme/HISTORY.md

This file was deleted.

7 changes: 0 additions & 7 deletions account_payment_currency_rate/readme/INSTALL.md

This file was deleted.

8 changes: 0 additions & 8 deletions account_payment_currency_rate/readme/USAGE.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
[ This file must be present and contains the usage instructions
for end-users. As all other rst files included in the README,
it MUST NOT contain reStructuredText sections
only body text (paragraphs, lists, tables, etc). Should you need
a more elaborate structure to explain the addon, please create a
Sphinx documentation (which may include this file as a "quick start"
section). ]

To use this module, you need to:

1. Go to Invoice Payment Wizard and change the rate.
110 changes: 26 additions & 84 deletions account_payment_currency_rate/static/description/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -369,125 +369,67 @@ <h1 class="title">Account Payment Currency Rate</h1>
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:d6e707c252f7cf4d8970346285f54f93b610994ea8b34e60368e95db3206c596
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external image-reference" 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 image-reference" 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 image-reference" href="https://github.com/OCA/kmee-odoo-addons/tree/16.0/account_payment_currency_rate"><img alt="OCA/kmee-odoo-addons" src="https://img.shields.io/badge/github-OCA%2Fkmee--odoo--addons-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/kmee-odoo-addons-16-0/kmee-odoo-addons-16-0-account_payment_currency_rate"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/kmee-odoo-addons&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p>[ This file must be max 2-3 paragraphs, and is required. ]</p>
<p><a class="reference external image-reference" 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 image-reference" 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 image-reference" href="https://github.com/KMEE/kmee-odoo-addons/tree/16.0/account_payment_currency_rate"><img alt="KMEE/kmee-odoo-addons" src="https://img.shields.io/badge/github-KMEE%2Fkmee--odoo--addons-lightgray.png?logo=github" /></a></p>
<p>The module allows users to adjust the amount of a payment based on
exchange rate fluctuations, ensuring that exchange rate differences are
correctly recorded as profit or loss and automatically reconciled. This
improves accounting accuracy in international transactions, where
exchange rates may vary between the time of invoice and the time of
payment.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#use-cases-context" id="toc-entry-1">Use Cases / Context</a></li>
<li><a class="reference internal" href="#installation" id="toc-entry-2">Installation</a></li>
<li><a class="reference internal" href="#configuration" id="toc-entry-3">Configuration</a></li>
<li><a class="reference internal" href="#usage" id="toc-entry-4">Usage</a></li>
<li><a class="reference internal" href="#changelog" id="toc-entry-5">Changelog</a><ul>
<li><a class="reference internal" href="#section-1" id="toc-entry-6">16.0.1.0.0 (2024-05-20)</a></li>
<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="#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>
<li><a class="reference internal" href="#bug-tracker" id="toc-entry-7">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="toc-entry-8">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="toc-entry-9">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="toc-entry-10">Contributors</a></li>
<li><a class="reference internal" href="#other-credits" id="toc-entry-11">Other credits</a></li>
<li><a class="reference internal" href="#maintainers" id="toc-entry-12">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>[ This file is optional but strongly suggested to allow end-users to
evaluate the module’s usefulness in their context. ]</p>
</div>
<div class="section" id="installation">
<h1><a class="toc-backref" href="#toc-entry-2">Installation</a></h1>
<p>[ This file must only be present if there are very specific installation
instructions, such as installing non-python dependencies. The audience
is systems administrators. ]</p>
<p>To install this module, you need to:</p>
<ol class="arabic simple">
<li>Do nothing</li>
</ol>
</div>
<div class="section" id="configuration">
<h1><a class="toc-backref" href="#toc-entry-3">Configuration</a></h1>
<p>[ This file is optional, it should explain how to configure the module
before using it; it is aimed at advanced users. ]</p>
<p>To configure this module, you need to:</p>
<ol class="arabic simple">
<li>Do nothing</li>
</ol>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#toc-entry-4">Usage</a></h1>
<p>[ This file must be present and contains the usage instructions for
end-users. As all other rst files included in the README, it MUST NOT
contain reStructuredText sections only body text (paragraphs, lists,
tables, etc). Should you need a more elaborate structure to explain the
addon, please create a Sphinx documentation (which may include this file
as a “quick start” section). ]</p>
<h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
<p>To use this module, you need to:</p>
<ol class="arabic simple">
<li>Go to Invoice Payment Wizard and change the rate.</li>
</ol>
</div>
<div class="section" id="changelog">
<h1><a class="toc-backref" href="#toc-entry-5">Changelog</a></h1>
<p>[ The change log. The goal of this file is to help readers understand
changes between version. The primary audience is end users and
integrators. Purely technical changes such as code refactoring must not
be mentioned here.</p>
<p>This file may contain ONE level of section titles, underlined with the ~
(tilde) character. Other section markers are forbidden and will likely
break the structure of the README.rst or other documents where this
fragment is included. ]</p>
<div class="section" id="section-1">
<h2><a class="toc-backref" href="#toc-entry-6">16.0.1.0.0 (2024-05-20)</a></h2>
<ul class="simple">
<li>First Release</li>
</ul>
</div>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#toc-entry-7">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/kmee-odoo-addons/issues">GitHub Issues</a>.
<h1><a class="toc-backref" href="#toc-entry-2">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/OCA/kmee-odoo-addons/issues/new?body=module:%20account_payment_currency_rate%0Aversion:%2016.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/KMEE/kmee-odoo-addons/issues/new?body=module:%20account_payment_currency_rate%0Aversion:%2016.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-8">Credits</a></h1>
<h1><a class="toc-backref" href="#toc-entry-3">Credits</a></h1>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#toc-entry-9">Authors</a></h2>
<h2><a class="toc-backref" href="#toc-entry-4">Authors</a></h2>
<ul class="simple">
<li>KMEE</li>
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#toc-entry-10">Contributors</a></h2>
<h2><a class="toc-backref" href="#toc-entry-5">Contributors</a></h2>
<ul class="simple">
<li>Luis Felipe Miléo <a class="reference external" href="mailto:mileo&#64;kmee.com.br">mileo&#64;kmee.com.br</a></li>
</ul>
</div>
<div class="section" id="other-credits">
<h2><a class="toc-backref" href="#toc-entry-11">Other credits</a></h2>
<p>[ This file is optional and contains additional credits, other than
authors, contributors, and maintainers. ]</p>
<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>KMEE</li>
<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-12">Maintainers</a></h2>
<p>This module is maintained by the OCA.</p>
<a class="reference external image-reference" href="https://odoo-community.org">
<img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" />
</a>
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/kmee-odoo-addons/tree/16.0/account_payment_currency_rate">OCA/kmee-odoo-addons</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
<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/16.0/account_payment_currency_rate">KMEE/kmee-odoo-addons</a> project on GitHub.</p>
<p>You are welcome to contribute.</p>
</div>
</div>
</div>
Expand Down
Loading
Loading