From 9af4922f35c6da564446b8f69b738b3ecbe14366 Mon Sep 17 00:00:00 2001 From: Juanjo Date: Mon, 22 Jul 2024 12:00:30 +0200 Subject: [PATCH] [IMP] contract_variable_quantity: pre-commit auto fixes --- contract_variable_quantity/README.rst | 69 ++++++++++--------- contract_variable_quantity/pyproject.toml | 3 + .../readme/CONFIGURE.md | 18 +++++ .../readme/CONFIGURE.rst | 16 ----- .../readme/CONTRIBUTORS.md | 10 +++ .../readme/CONTRIBUTORS.rst | 9 --- .../{DESCRIPTION.rst => DESCRIPTION.md} | 0 contract_variable_quantity/readme/USAGE.md | 8 +++ contract_variable_quantity/readme/USAGE.rst | 7 -- .../static/description/index.html | 30 ++++---- 10 files changed, 93 insertions(+), 77 deletions(-) create mode 100644 contract_variable_quantity/pyproject.toml create mode 100644 contract_variable_quantity/readme/CONFIGURE.md delete mode 100644 contract_variable_quantity/readme/CONFIGURE.rst create mode 100644 contract_variable_quantity/readme/CONTRIBUTORS.md delete mode 100644 contract_variable_quantity/readme/CONTRIBUTORS.rst rename contract_variable_quantity/readme/{DESCRIPTION.rst => DESCRIPTION.md} (100%) create mode 100644 contract_variable_quantity/readme/USAGE.md delete mode 100644 contract_variable_quantity/readme/USAGE.rst diff --git a/contract_variable_quantity/README.rst b/contract_variable_quantity/README.rst index 9267af87b..43b19cbe3 100644 --- a/contract_variable_quantity/README.rst +++ b/contract_variable_quantity/README.rst @@ -17,13 +17,13 @@ Variable quantity in contract recurrent invoicing :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html :alt: License: AGPL-3 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fcontract-lightgray.png?logo=github - :target: https://github.com/OCA/contract/tree/16.0/contract_variable_quantity + :target: https://github.com/OCA/contract/tree/17.0/contract_variable_quantity :alt: OCA/contract .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png - :target: https://translation.odoo-community.org/projects/contract-16-0/contract-16-0-contract_variable_quantity + :target: https://translation.odoo-community.org/projects/contract-17-0/contract-17-0-contract_variable_quantity :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/contract&target_branch=16.0 + :target: https://runboat.odoo-community.org/builds?repo=OCA/contract&target_branch=17.0 :alt: Try me on Runboat |badge1| |badge2| |badge3| |badge4| |badge5| @@ -39,33 +39,37 @@ lines with variable quantity according to a provided formula. Configuration ============= -#. Go to Invoicing > Configuration > Contracts > Formulas (quantity). -#. Define any formula based on Python code that stores at some moment a - float/integer value of the quantity to invoice in the variable 'result'. +1. Go to Invoicing > Configuration > Contracts > Formulas (quantity). + +2. Define any formula based on Python code that stores at some moment a + float/integer value of the quantity to invoice in the variable + 'result'. You can use these variables to compute your formula: - * *env*: Environment variable for getting other models. - * *context*: Current context dictionary. - * *user*: Current user. - * *line*: Contract recurring invoice line that triggers this formula. - * *contract*: Contract whose line belongs to. - * *invoice*: Invoice (header) being created. + - *env*: Environment variable for getting other models. + - *context*: Current context dictionary. + - *user*: Current user. + - *line*: Contract recurring invoice line that triggers this + formula. + - *contract*: Contract whose line belongs to. + - *invoice*: Invoice (header) being created. -.. figure:: https://raw.githubusercontent.com/OCA/contract/16.0/contract_variable_quantity/images/formula_form.png - :alt: Formula form - :width: 600 px +|image1| + +.. |image1| image:: https://raw.githubusercontent.com/OCA/contract/17.0/contract_variable_quantity/images/formula_form.png Usage ===== To use this module, you need to: -#. Go to Invoicing > Sales > Contracts and select or create a new contract. -#. Check *Generate recurring invoices automatically*. -#. Add a new recurring invoicing line. -#. Select "Variable quantity" in column "Qty. type". -#. Select one of the possible formulas to use (previously created). +1. Go to Invoicing > Sales > Contracts and select or create a new + contract. +2. Check *Generate recurring invoices automatically*. +3. Add a new recurring invoicing line. +4. Select "Variable quantity" in column "Qty. type". +5. Select one of the possible formulas to use (previously created). Bug Tracker =========== @@ -73,7 +77,7 @@ Bug Tracker Bugs are tracked on `GitHub 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 `_. +`feedback `_. Do not contact contributors directly about support or help with technical issues. @@ -81,25 +85,26 @@ Credits ======= Authors -~~~~~~~ +------- * Tecnativa Contributors -~~~~~~~~~~~~ +------------ -* `Tecnativa `_: +- `Tecnativa `__: - * Pedro M. Baeza - * Carlos Roca - * Víctor Martínez - * Carolina Fernandez + - Pedro M. Baeza + - Carlos Roca + - Víctor Martínez + - Carolina Fernandez -* Dave Lasley -* Souheil Bejaoui +- Dave Lasley + +- Souheil Bejaoui Maintainers -~~~~~~~~~~~ +----------- This module is maintained by the OCA. @@ -111,6 +116,6 @@ 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/contract `_ project on GitHub. +This module is part of the `OCA/contract `_ project on GitHub. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/contract_variable_quantity/pyproject.toml b/contract_variable_quantity/pyproject.toml new file mode 100644 index 000000000..4231d0ccc --- /dev/null +++ b/contract_variable_quantity/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/contract_variable_quantity/readme/CONFIGURE.md b/contract_variable_quantity/readme/CONFIGURE.md new file mode 100644 index 000000000..ff9fc124c --- /dev/null +++ b/contract_variable_quantity/readme/CONFIGURE.md @@ -0,0 +1,18 @@ +1. Go to Invoicing \> Configuration \> Contracts \> Formulas + (quantity). + +2. Define any formula based on Python code that stores at some moment a + float/integer value of the quantity to invoice in the variable + 'result'. + + You can use these variables to compute your formula: + + - *env*: Environment variable for getting other models. + - *context*: Current context dictionary. + - *user*: Current user. + - *line*: Contract recurring invoice line that triggers this + formula. + - *contract*: Contract whose line belongs to. + - *invoice*: Invoice (header) being created. + +![](images/formula_form.png) diff --git a/contract_variable_quantity/readme/CONFIGURE.rst b/contract_variable_quantity/readme/CONFIGURE.rst deleted file mode 100644 index 73ff8a376..000000000 --- a/contract_variable_quantity/readme/CONFIGURE.rst +++ /dev/null @@ -1,16 +0,0 @@ -#. Go to Invoicing > Configuration > Contracts > Formulas (quantity). -#. Define any formula based on Python code that stores at some moment a - float/integer value of the quantity to invoice in the variable 'result'. - - You can use these variables to compute your formula: - - * *env*: Environment variable for getting other models. - * *context*: Current context dictionary. - * *user*: Current user. - * *line*: Contract recurring invoice line that triggers this formula. - * *contract*: Contract whose line belongs to. - * *invoice*: Invoice (header) being created. - -.. figure:: images/formula_form.png - :alt: Formula form - :width: 600 px diff --git a/contract_variable_quantity/readme/CONTRIBUTORS.md b/contract_variable_quantity/readme/CONTRIBUTORS.md new file mode 100644 index 000000000..b4af30c20 --- /dev/null +++ b/contract_variable_quantity/readme/CONTRIBUTORS.md @@ -0,0 +1,10 @@ +- [Tecnativa](https://www.tecnativa.com): + + > - Pedro M. Baeza + > - Carlos Roca + > - Víctor Martínez + > - Carolina Fernandez + +- Dave Lasley \<\> + +- Souheil Bejaoui \<\> diff --git a/contract_variable_quantity/readme/CONTRIBUTORS.rst b/contract_variable_quantity/readme/CONTRIBUTORS.rst deleted file mode 100644 index a98f7f09b..000000000 --- a/contract_variable_quantity/readme/CONTRIBUTORS.rst +++ /dev/null @@ -1,9 +0,0 @@ -* `Tecnativa `_: - - * Pedro M. Baeza - * Carlos Roca - * Víctor Martínez - * Carolina Fernandez - -* Dave Lasley -* Souheil Bejaoui diff --git a/contract_variable_quantity/readme/DESCRIPTION.rst b/contract_variable_quantity/readme/DESCRIPTION.md similarity index 100% rename from contract_variable_quantity/readme/DESCRIPTION.rst rename to contract_variable_quantity/readme/DESCRIPTION.md diff --git a/contract_variable_quantity/readme/USAGE.md b/contract_variable_quantity/readme/USAGE.md new file mode 100644 index 000000000..d2a4a2e57 --- /dev/null +++ b/contract_variable_quantity/readme/USAGE.md @@ -0,0 +1,8 @@ +To use this module, you need to: + +1. Go to Invoicing \> Sales \> Contracts and select or create a new + contract. +2. Check *Generate recurring invoices automatically*. +3. Add a new recurring invoicing line. +4. Select "Variable quantity" in column "Qty. type". +5. Select one of the possible formulas to use (previously created). diff --git a/contract_variable_quantity/readme/USAGE.rst b/contract_variable_quantity/readme/USAGE.rst deleted file mode 100644 index 6de2d0e22..000000000 --- a/contract_variable_quantity/readme/USAGE.rst +++ /dev/null @@ -1,7 +0,0 @@ -To use this module, you need to: - -#. Go to Invoicing > Sales > Contracts and select or create a new contract. -#. Check *Generate recurring invoices automatically*. -#. Add a new recurring invoicing line. -#. Select "Variable quantity" in column "Qty. type". -#. Select one of the possible formulas to use (previously created). diff --git a/contract_variable_quantity/static/description/index.html b/contract_variable_quantity/static/description/index.html index f4e51ed10..9a17e2509 100644 --- a/contract_variable_quantity/static/description/index.html +++ b/contract_variable_quantity/static/description/index.html @@ -8,10 +8,11 @@ /* :Author: David Goodger (goodger@python.org) -:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $ +:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $ :Copyright: This stylesheet has been placed in the public domain. Default cascading style sheet for the HTML output of Docutils. +Despite the name, some widely supported CSS2 features are used. See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to customize this style sheet. @@ -274,7 +275,7 @@ pre.literal-block, pre.doctest-block, pre.math, pre.code { margin-left: 2em ; margin-right: 2em } -pre.code .ln { color: grey; } /* line numbers */ +pre.code .ln { color: gray; } /* line numbers */ pre.code, code { background-color: #eeeeee } pre.code .comment, code .comment { color: #5C6576 } pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold } @@ -300,7 +301,7 @@ span.option { span.pre { white-space: pre } -span.problematic { +span.problematic, pre.problematic { color: red } span.section-subtitle { @@ -368,7 +369,7 @@ ul.auto-toc { !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !! source digest: sha256:7dad3fabe1f8a0ae7a25a3320507edb1f3c5c88cd5f4000a85ed524ffc321cfb !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> -

Beta License: AGPL-3 OCA/contract Translate me on Weblate Try me on Runboat

+

Beta License: AGPL-3 OCA/contract Translate me on Weblate Try me on Runboat

With this module, you will be able to define in recurring contracts some lines with variable quantity according to a provided formula.

Table of contents

@@ -391,27 +392,28 @@ lines with variable quantity according to a provided formula.

  • Go to Invoicing > Configuration > Contracts > Formulas (quantity).

  • Define any formula based on Python code that stores at some moment a -float/integer value of the quantity to invoice in the variable ‘result’.

    +float/integer value of the quantity to invoice in the variable +‘result’.

    You can use these variables to compute your formula:

    • env: Environment variable for getting other models.
    • context: Current context dictionary.
    • user: Current user.
      • -
    • line: Contract recurring invoice line that triggers this formula.
      • +
    • line: Contract recurring invoice line that triggers this +formula.
    • contract: Contract whose line belongs to.
    • invoice: Invoice (header) being created.
    • -
    -Formula form -
    +

    image1

    Usage

    To use this module, you need to:

      -
    1. Go to Invoicing > Sales > Contracts and select or create a new contract.
      2. +
    2. Go to Invoicing > Sales > Contracts and select or create a new +contract.
    3. Check Generate recurring invoices automatically.
    4. Add a new recurring invoicing line.
    5. Select “Variable quantity” in column “Qty. type”.
      6. @@ -423,7 +425,7 @@ float/integer value of the quantity to invoice in the variable ‘result’.

      Bugs are tracked on GitHub 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.

      +feedback.

      Do not contact contributors directly about support or help with technical issues.

    @@ -456,11 +458,13 @@ If you spotted it first, help us to smash it by providing a detailed and welcome

    Maintainers

    This module is maintained by the OCA.

    -Odoo Community Association + +Odoo Community Association +

    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/contract project on GitHub.

    +

    This module is part of the OCA/contract project on GitHub.

    You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.