From 2c2e1fb1fa55ed43a2eda3321efa0acf1f13a94b Mon Sep 17 00:00:00 2001 From: Mikel Martin Date: Wed, 31 Jan 2024 23:44:13 +0100 Subject: [PATCH] [IMP] document_knowledge: pre-commit auto fixes --- document_knowledge/README.rst | 75 ++++++++++--------- document_knowledge/pyproject.toml | 3 + document_knowledge/readme/CONFIGURE.md | 19 +++++ document_knowledge/readme/CONFIGURE.rst | 20 ----- document_knowledge/readme/CONTRIBUTORS.md | 16 ++++ document_knowledge/readme/CONTRIBUTORS.rst | 17 ----- .../readme/{CREDITS.rst => CREDITS.md} | 2 +- .../{DESCRIPTION.rst => DESCRIPTION.md} | 3 +- .../readme/{USAGE.rst => USAGE.md} | 4 +- .../static/description/index.html | 28 +++---- 10 files changed, 96 insertions(+), 91 deletions(-) create mode 100644 document_knowledge/pyproject.toml create mode 100644 document_knowledge/readme/CONFIGURE.md delete mode 100644 document_knowledge/readme/CONFIGURE.rst create mode 100644 document_knowledge/readme/CONTRIBUTORS.md delete mode 100644 document_knowledge/readme/CONTRIBUTORS.rst rename document_knowledge/readme/{CREDITS.rst => CREDITS.md} (83%) rename document_knowledge/readme/{DESCRIPTION.rst => DESCRIPTION.md} (81%) rename document_knowledge/readme/{USAGE.rst => USAGE.md} (78%) diff --git a/document_knowledge/README.rst b/document_knowledge/README.rst index 61ffd821..9b8a35fe 100644 --- a/document_knowledge/README.rst +++ b/document_knowledge/README.rst @@ -17,18 +17,19 @@ Documents Knowledge :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html :alt: License: AGPL-3 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fknowledge-lightgray.png?logo=github - :target: https://github.com/OCA/knowledge/tree/16.0/document_knowledge + :target: https://github.com/OCA/knowledge/tree/17.0/document_knowledge :alt: OCA/knowledge .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png - :target: https://translation.odoo-community.org/projects/knowledge-16-0/knowledge-16-0-document_knowledge + :target: https://translation.odoo-community.org/projects/knowledge-17-0/knowledge-17-0-document_knowledge :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/knowledge&target_branch=16.0 + :target: https://runboat.odoo-community.org/builds?repo=OCA/knowledge&target_branch=17.0 :alt: Try me on Runboat |badge1| |badge2| |badge3| |badge4| |badge5| -This module is the base for any knowledge and document management application. +This module is the base for any knowledge and document management +application. **Table of contents** @@ -40,23 +41,23 @@ Configuration To set up this module, you need to go to: -* Knowledge / Configuration / Settings +- Knowledge / Configuration / Settings -From this menu you'll have a central access to install the apps that belong -to Knowledge. +From this menu you'll have a central access to install the apps that +belong to Knowledge. -* Check *Attachments List and Document Indexation* if you want to install the - module that allows users to attach documents to any model. -* Check *Manage attachments centrally* if you want all users to be able to - access to the all attachments to which they have read permissions, from the - menu *Knowledge / Documents* +- Check *Attachments List and Document Indexation* if you want to + install the module that allows users to attach documents to any + model. +- Check *Manage attachments centrally* if you want all users to be able + to access to the all attachments to which they have read permissions, + from the menu *Knowledge / Documents* If you want to grant Central Access to Documents only to some users: -#. Go to *Settings/Activate the developer mode*. Only a user with +1. Go to *Settings/Activate the developer mode*. Only a user with *Administration / Settings* permissions can do that. - -#. Go to *Settings / Users & Companies / Users* and set the checkbox +2. Go to *Settings / Users & Companies / Users* and set the checkbox *Central access to Documents* to the selected users. Usage @@ -65,8 +66,8 @@ Usage This module adds a new top level menu *Knowledge* Users with permission *Central access to Documents* can access in -*Knowledge/Documents* to all the documents attached to records of any model -for which they have read permission. +*Knowledge/Documents* to all the documents attached to records of any +model for which they have read permission. Bug Tracker =========== @@ -74,7 +75,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. @@ -82,7 +83,7 @@ Credits ======= Authors -~~~~~~~ +------- * OpenERP SA * MONK Software @@ -90,35 +91,35 @@ Authors * ForgeFlow Contributors -~~~~~~~~~~~~ +------------ -* Odoo SA -* Savoir-faire Linux -* Gervais Naoussi -* Leonardo Donelli -* Maxime Chambreuil -* Fayez Qandeel -* Iván Todorovich -* Jordi Ballester -* Marie Lejeune -* `Tecnativa `_: +- Odoo SA +- Savoir-faire Linux +- Gervais Naoussi +- Leonardo Donelli +- Maxime Chambreuil +- Fayez Qandeel +- Iván Todorovich +- Jordi Ballester +- Marie Lejeune +- `Tecnativa `__: - * Vicent Cubells - * Ernesto Tejeda + - Vicent Cubells + - Ernesto Tejeda Trobz -* Dung Tran +- Dung Tran Other credits -~~~~~~~~~~~~~ +------------- The development of this module has been financially supported by: -* Camptocamp +- Camptocamp Maintainers -~~~~~~~~~~~ +----------- This module is maintained by the OCA. @@ -130,6 +131,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/knowledge `_ project on GitHub. +This module is part of the `OCA/knowledge `_ project on GitHub. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/document_knowledge/pyproject.toml b/document_knowledge/pyproject.toml new file mode 100644 index 00000000..4231d0cc --- /dev/null +++ b/document_knowledge/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/document_knowledge/readme/CONFIGURE.md b/document_knowledge/readme/CONFIGURE.md new file mode 100644 index 00000000..aae82246 --- /dev/null +++ b/document_knowledge/readme/CONFIGURE.md @@ -0,0 +1,19 @@ +To set up this module, you need to go to: + +- Knowledge / Configuration / Settings + +From this menu you'll have a central access to install the apps that +belong to Knowledge. + +- Check *Attachments List and Document Indexation* if you want to + install the module that allows users to attach documents to any model. +- Check *Manage attachments centrally* if you want all users to be able + to access to the all attachments to which they have read permissions, + from the menu *Knowledge / Documents* + +If you want to grant Central Access to Documents only to some users: + +1. Go to *Settings/Activate the developer mode*. Only a user with + *Administration / Settings* permissions can do that. +2. Go to *Settings / Users & Companies / Users* and set the checkbox + *Central access to Documents* to the selected users. diff --git a/document_knowledge/readme/CONFIGURE.rst b/document_knowledge/readme/CONFIGURE.rst deleted file mode 100644 index ff972422..00000000 --- a/document_knowledge/readme/CONFIGURE.rst +++ /dev/null @@ -1,20 +0,0 @@ -To set up this module, you need to go to: - -* Knowledge / Configuration / Settings - -From this menu you'll have a central access to install the apps that belong -to Knowledge. - -* Check *Attachments List and Document Indexation* if you want to install the - module that allows users to attach documents to any model. -* Check *Manage attachments centrally* if you want all users to be able to - access to the all attachments to which they have read permissions, from the - menu *Knowledge / Documents* - -If you want to grant Central Access to Documents only to some users: - -#. Go to *Settings/Activate the developer mode*. Only a user with - *Administration / Settings* permissions can do that. - -#. Go to *Settings / Users & Companies / Users* and set the checkbox - *Central access to Documents* to the selected users. diff --git a/document_knowledge/readme/CONTRIBUTORS.md b/document_knowledge/readme/CONTRIBUTORS.md new file mode 100644 index 00000000..a5715305 --- /dev/null +++ b/document_knowledge/readme/CONTRIBUTORS.md @@ -0,0 +1,16 @@ +- Odoo SA \<\> +- Savoir-faire Linux \<\> +- Gervais Naoussi \<\> +- Leonardo Donelli \<\> +- Maxime Chambreuil \<\> +- Fayez Qandeel +- Iván Todorovich \<\> +- Jordi Ballester \<\> +- Marie Lejeune \<\> +- [Tecnativa](https://www.tecnativa.com): + - Vicent Cubells + - Ernesto Tejeda + +Trobz + +- Dung Tran \<\> diff --git a/document_knowledge/readme/CONTRIBUTORS.rst b/document_knowledge/readme/CONTRIBUTORS.rst deleted file mode 100644 index 13813346..00000000 --- a/document_knowledge/readme/CONTRIBUTORS.rst +++ /dev/null @@ -1,17 +0,0 @@ -* Odoo SA -* Savoir-faire Linux -* Gervais Naoussi -* Leonardo Donelli -* Maxime Chambreuil -* Fayez Qandeel -* Iván Todorovich -* Jordi Ballester -* Marie Lejeune -* `Tecnativa `_: - - * Vicent Cubells - * Ernesto Tejeda - -Trobz - -* Dung Tran diff --git a/document_knowledge/readme/CREDITS.rst b/document_knowledge/readme/CREDITS.md similarity index 83% rename from document_knowledge/readme/CREDITS.rst rename to document_knowledge/readme/CREDITS.md index f5cc070c..705d3b30 100644 --- a/document_knowledge/readme/CREDITS.rst +++ b/document_knowledge/readme/CREDITS.md @@ -1,3 +1,3 @@ The development of this module has been financially supported by: -* Camptocamp +- Camptocamp diff --git a/document_knowledge/readme/DESCRIPTION.rst b/document_knowledge/readme/DESCRIPTION.md similarity index 81% rename from document_knowledge/readme/DESCRIPTION.rst rename to document_knowledge/readme/DESCRIPTION.md index 6c4996bc..1e310f44 100644 --- a/document_knowledge/readme/DESCRIPTION.rst +++ b/document_knowledge/readme/DESCRIPTION.md @@ -1 +1,2 @@ -This module is the base for any knowledge and document management application. +This module is the base for any knowledge and document management +application. diff --git a/document_knowledge/readme/USAGE.rst b/document_knowledge/readme/USAGE.md similarity index 78% rename from document_knowledge/readme/USAGE.rst rename to document_knowledge/readme/USAGE.md index 328eb25e..0ab0270e 100644 --- a/document_knowledge/readme/USAGE.rst +++ b/document_knowledge/readme/USAGE.md @@ -1,5 +1,5 @@ This module adds a new top level menu *Knowledge* Users with permission *Central access to Documents* can access in -*Knowledge/Documents* to all the documents attached to records of any model -for which they have read permission. +*Knowledge/Documents* to all the documents attached to records of any +model for which they have read permission. diff --git a/document_knowledge/static/description/index.html b/document_knowledge/static/description/index.html index 7d10a1ba..462af4dc 100644 --- a/document_knowledge/static/description/index.html +++ b/document_knowledge/static/description/index.html @@ -369,8 +369,9 @@ ul.auto-toc { !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !! source digest: sha256:c1488375286777cfdb9187452f29e3f8a28157ba0f11fa21061916703e669afc !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> -

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

-

This module is the base for any knowledge and document management application.

+

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

+

This module is the base for any knowledge and document management +application.

Table of contents

    @@ -392,14 +393,15 @@ ul.auto-toc {
    • Knowledge / Configuration / Settings
    -

    From this menu you’ll have a central access to install the apps that belong -to Knowledge.

    +

    From this menu you’ll have a central access to install the apps that +belong to Knowledge.

      -
    • Check Attachments List and Document Indexation if you want to install the -module that allows users to attach documents to any model.
      • -
    • Check Manage attachments centrally if you want all users to be able to -access to the all attachments to which they have read permissions, from the -menu Knowledge / Documents
      • +
    • Check Attachments List and Document Indexation if you want to +install the module that allows users to attach documents to any +model.
      • +
    • Check Manage attachments centrally if you want all users to be able +to access to the all attachments to which they have read permissions, +from the menu Knowledge / Documents

    If you want to grant Central Access to Documents only to some users:

      @@ -413,15 +415,15 @@ menu Knowledge / Documents

      Usage

      This module adds a new top level menu Knowledge

      Users with permission Central access to Documents can access in -Knowledge/Documents to all the documents attached to records of any model -for which they have read permission.

      +Knowledge/Documents to all the documents attached to records of any +model for which they have read permission.

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.

@@ -472,7 +474,7 @@ If you spotted it first, help us to smash it by providing a detailed and welcome

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

+

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

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