From 9eb5ce0e8b48bc2fc028cafe0e1f7e216586774b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alberto=20Mart=C3=ADnez?= Date: Tue, 19 Mar 2024 16:45:26 +0100 Subject: [PATCH] [IMP] document_page: pre-commit auto fixes --- document_page/README.rst | 60 ++++++++++--------- document_page/pyproject.toml | 3 + .../readme/{CONFIGURE.rst => CONFIGURE.md} | 0 document_page/readme/CONTRIBUTORS.md | 15 +++++ document_page/readme/CONTRIBUTORS.rst | 18 ------ document_page/readme/CREDITS.md | 5 ++ document_page/readme/CREDITS.rst | 5 -- .../{DESCRIPTION.rst => DESCRIPTION.md} | 0 .../readme/{INSTALL.rst => INSTALL.md} | 3 +- document_page/readme/USAGE.md | 7 +++ document_page/readme/USAGE.rst | 5 -- document_page/static/description/index.html | 16 +++-- 12 files changed, 73 insertions(+), 64 deletions(-) create mode 100644 document_page/pyproject.toml rename document_page/readme/{CONFIGURE.rst => CONFIGURE.md} (100%) create mode 100644 document_page/readme/CONTRIBUTORS.md delete mode 100644 document_page/readme/CONTRIBUTORS.rst create mode 100644 document_page/readme/CREDITS.md delete mode 100644 document_page/readme/CREDITS.rst rename document_page/readme/{DESCRIPTION.rst => DESCRIPTION.md} (100%) rename document_page/readme/{INSTALL.rst => INSTALL.md} (74%) create mode 100644 document_page/readme/USAGE.md delete mode 100644 document_page/readme/USAGE.rst diff --git a/document_page/README.rst b/document_page/README.rst index fd2e6700..5a615f66 100644 --- a/document_page/README.rst +++ b/document_page/README.rst @@ -17,13 +17,13 @@ Document Page :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_page + :target: https://github.com/OCA/knowledge/tree/17.0/document_page :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_page + :target: https://translation.odoo-community.org/projects/knowledge-17-0/knowledge-17-0-document_page :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| @@ -38,7 +38,8 @@ This module allows you to write web pages for internal documentation. Installation ============ -This module depends on module knowledge. So make sure to have it in your addons list. +This module depends on module knowledge. So make sure to have it in your +addons list. Configuration ============= @@ -50,9 +51,11 @@ Usage To use this module, you need to: -* Go to Knowledge menu -* Click on Categories to create the document's category you need with the template -* Click on Pages to create pages and select the previous category to use the template +- Go to Knowledge menu +- Click on Categories to create the document's category you need with + the template +- Click on Pages to create pages and select the previous category to + use the template Bug Tracker =========== @@ -60,7 +63,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. @@ -68,43 +71,42 @@ Credits ======= Authors -~~~~~~~ +------- * OpenERP SA Contributors -~~~~~~~~~~~~ +------------ -* Gervais Naoussi -* Maxime Chambreuil -* Iván Todorovich -* Jose Maria Alzaga -* Lois Rilo -* Simone Orsi -* `Tecnativa `_: +- Gervais Naoussi +- Maxime Chambreuil +- Iván Todorovich +- Jose Maria Alzaga +- Lois Rilo +- Simone Orsi +- `Tecnativa `__: - * Ernesto Tejeda - * Víctor Martínez + - Ernesto Tejeda + - Víctor Martínez Trobz -* Dung Tran +- Dung Tran +- `Sygel `__: -* `Sygel `_: - - * Ángel García de la Chica Herrera + - Ángel García de la Chica Herrera Other credits -~~~~~~~~~~~~~ +------------- The development of this module has been financially supported by: -* Odoo SA -* Savoir-faire Linux -* Camptocamp +- Odoo SA +- Savoir-faire Linux +- Camptocamp Maintainers -~~~~~~~~~~~ +----------- This module is maintained by the OCA. @@ -116,6 +118,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_page/pyproject.toml b/document_page/pyproject.toml new file mode 100644 index 00000000..4231d0cc --- /dev/null +++ b/document_page/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/document_page/readme/CONFIGURE.rst b/document_page/readme/CONFIGURE.md similarity index 100% rename from document_page/readme/CONFIGURE.rst rename to document_page/readme/CONFIGURE.md diff --git a/document_page/readme/CONTRIBUTORS.md b/document_page/readme/CONTRIBUTORS.md new file mode 100644 index 00000000..8e410db7 --- /dev/null +++ b/document_page/readme/CONTRIBUTORS.md @@ -0,0 +1,15 @@ +- Gervais Naoussi \<\> +- Maxime Chambreuil \<\> +- Iván Todorovich \<\> +- Jose Maria Alzaga \<\> +- Lois Rilo \<\> +- Simone Orsi \<\> +- [Tecnativa](https://www.tecnativa.com): + - Ernesto Tejeda + - Víctor Martínez + +Trobz + +- Dung Tran \<\> +- [Sygel](https://www.sygel.es): + - Ángel García de la Chica Herrera diff --git a/document_page/readme/CONTRIBUTORS.rst b/document_page/readme/CONTRIBUTORS.rst deleted file mode 100644 index a45e3a71..00000000 --- a/document_page/readme/CONTRIBUTORS.rst +++ /dev/null @@ -1,18 +0,0 @@ -* Gervais Naoussi -* Maxime Chambreuil -* Iván Todorovich -* Jose Maria Alzaga -* Lois Rilo -* Simone Orsi -* `Tecnativa `_: - - * Ernesto Tejeda - * Víctor Martínez - -Trobz - -* Dung Tran - -* `Sygel `_: - - * Ángel García de la Chica Herrera diff --git a/document_page/readme/CREDITS.md b/document_page/readme/CREDITS.md new file mode 100644 index 00000000..7d4fb33f --- /dev/null +++ b/document_page/readme/CREDITS.md @@ -0,0 +1,5 @@ +The development of this module has been financially supported by: + +- Odoo SA \<\> +- Savoir-faire Linux \<\> +- Camptocamp diff --git a/document_page/readme/CREDITS.rst b/document_page/readme/CREDITS.rst deleted file mode 100644 index 6ce07dd6..00000000 --- a/document_page/readme/CREDITS.rst +++ /dev/null @@ -1,5 +0,0 @@ -The development of this module has been financially supported by: - -* Odoo SA -* Savoir-faire Linux -* Camptocamp diff --git a/document_page/readme/DESCRIPTION.rst b/document_page/readme/DESCRIPTION.md similarity index 100% rename from document_page/readme/DESCRIPTION.rst rename to document_page/readme/DESCRIPTION.md diff --git a/document_page/readme/INSTALL.rst b/document_page/readme/INSTALL.md similarity index 74% rename from document_page/readme/INSTALL.rst rename to document_page/readme/INSTALL.md index b643617c..9304c55f 100644 --- a/document_page/readme/INSTALL.rst +++ b/document_page/readme/INSTALL.md @@ -1 +1,2 @@ -This module depends on module knowledge. So make sure to have it in your addons list. +This module depends on module knowledge. So make sure to have it in your +addons list. diff --git a/document_page/readme/USAGE.md b/document_page/readme/USAGE.md new file mode 100644 index 00000000..8ba0011a --- /dev/null +++ b/document_page/readme/USAGE.md @@ -0,0 +1,7 @@ +To use this module, you need to: + +- Go to Knowledge menu +- Click on Categories to create the document's category you need with + the template +- Click on Pages to create pages and select the previous category to use + the template diff --git a/document_page/readme/USAGE.rst b/document_page/readme/USAGE.rst deleted file mode 100644 index 8576f8fc..00000000 --- a/document_page/readme/USAGE.rst +++ /dev/null @@ -1,5 +0,0 @@ -To use this module, you need to: - -* Go to Knowledge menu -* Click on Categories to create the document's category you need with the template -* Click on Pages to create pages and select the previous category to use the template diff --git a/document_page/static/description/index.html b/document_page/static/description/index.html index 2d0af22d..34adb598 100644 --- a/document_page/static/description/index.html +++ b/document_page/static/description/index.html @@ -1,3 +1,4 @@ + @@ -368,7 +369,7 @@ ul.auto-toc { !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !! source digest: sha256:e1cef658d69a07a964bb6344e6463d07e416b84be3ecd65118e47174e29411be !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> -

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

+

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

This module allows you to write web pages for internal documentation.

Table of contents

@@ -388,7 +389,8 @@ ul.auto-toc {

Installation

-

This module depends on module knowledge. So make sure to have it in your addons list.

+

This module depends on module knowledge. So make sure to have it in your +addons list.

Configuration

@@ -399,8 +401,10 @@ ul.auto-toc {

To use this module, you need to:

  • Go to Knowledge menu
    • -
  • Click on Categories to create the document’s category you need with the template
    • -
  • Click on Pages to create pages and select the previous category to use the template
    • +
  • Click on Categories to create the document’s category you need with +the template
    • +
  • Click on Pages to create pages and select the previous category to +use the template
@@ -408,7 +412,7 @@ ul.auto-toc {

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.

@@ -459,7 +463,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.