From 24a30554baa4c313fc13721b7dfda9307f60c2f9 Mon Sep 17 00:00:00 2001
From: Carlos Lopez <carlos.lopez@tecnativa.com>
Date: Fri, 15 Nov 2024 10:49:35 -0500
Subject: [PATCH] [IMP] web_editor_class_selector: pre-commit stuff
---
web_editor_class_selector/README.rst | 34 +++++++++++--------
web_editor_class_selector/pyproject.toml | 3 ++
.../readme/DESCRIPTION.md | 4 +++
.../readme/DESCRIPTION.rst | 2 --
web_editor_class_selector/readme/ROADMAP.md | 2 ++
web_editor_class_selector/readme/ROADMAP.rst | 1 -
web_editor_class_selector/readme/USAGE.md | 6 ++++
web_editor_class_selector/readme/USAGE.rst | 5 ---
.../static/description/index.html | 20 ++++++-----
9 files changed, 46 insertions(+), 31 deletions(-)
create mode 100644 web_editor_class_selector/pyproject.toml
create mode 100644 web_editor_class_selector/readme/DESCRIPTION.md
delete mode 100644 web_editor_class_selector/readme/DESCRIPTION.rst
create mode 100644 web_editor_class_selector/readme/ROADMAP.md
delete mode 100644 web_editor_class_selector/readme/ROADMAP.rst
create mode 100644 web_editor_class_selector/readme/USAGE.md
delete mode 100644 web_editor_class_selector/readme/USAGE.rst
diff --git a/web_editor_class_selector/README.rst b/web_editor_class_selector/README.rst
index bb3bd6532..c020da6a5 100644
--- a/web_editor_class_selector/README.rst
+++ b/web_editor_class_selector/README.rst
@@ -17,19 +17,21 @@ Web editor class selector
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github
- :target: https://github.com/OCA/web/tree/16.0/web_editor_class_selector
+ :target: https://github.com/OCA/web/tree/17.0/web_editor_class_selector
:alt: OCA/web
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
- :target: https://translation.odoo-community.org/projects/web-16-0/web-16-0-web_editor_class_selector
+ :target: https://translation.odoo-community.org/projects/web-17-0/web-17-0-web_editor_class_selector
: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/web&target_branch=16.0
+ :target: https://runboat.odoo-community.org/builds?repo=OCA/web&target_branch=17.0
:alt: Try me on Runboat
|badge1| |badge2| |badge3| |badge4| |badge5|
-This module allows users to create custom CSS class records, which can then be selected and applied directly in the HTML editor.
-Note: The actual CSS file containing the class definitions is not provided by this module and must be loaded in a custom module.
+This module allows users to create custom CSS class records, which can
+then be selected and applied directly in the HTML editor. Note: The
+actual CSS file containing the class definitions is not provided by this
+module and must be loaded in a custom module.
**Table of contents**
@@ -39,16 +41,18 @@ Note: The actual CSS file containing the class definitions is not provided by th
Usage
=====
-* Go to `Settings` > `Technical` > `User Interface` > `Web editor Class`.
-* Create and name your custom CSS classes.
-* Go to any model with an HTML field (e.g., `Settings` > `Users` > `Preferences` > `Signature`).
-* In the HTML editor, select any content block.
-* Choose from the available CSS classes to apply the desired styling.
+- Go to Settings > Technical > User Interface > Web editor Class.
+- Create and name your custom CSS classes.
+- Go to any model with an HTML field (e.g., Settings > Users >
+ Preferences > Signature).
+- In the HTML editor, select any content block.
+- Choose from the available CSS classes to apply the desired styling.
Known issues / Roadmap
======================
-Add support to apply class to any element (currently, only `span` is supported)
+Add support to apply class to any element (currently, only span is
+supported)
Bug Tracker
===========
@@ -56,7 +60,7 @@ Bug Tracker
Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/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/web/issues/new?body=module:%20web_editor_class_selector%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+`feedback <https://github.com/OCA/web/issues/new?body=module:%20web_editor_class_selector%0Aversion:%2017.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.
@@ -64,12 +68,12 @@ Credits
=======
Authors
-~~~~~~~
+-------
* Tecnativa
Maintainers
-~~~~~~~~~~~
+-----------
This module is maintained by the OCA.
@@ -81,6 +85,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/web <https://github.com/OCA/web/tree/16.0/web_editor_class_selector>`_ project on GitHub.
+This module is part of the `OCA/web <https://github.com/OCA/web/tree/17.0/web_editor_class_selector>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
diff --git a/web_editor_class_selector/pyproject.toml b/web_editor_class_selector/pyproject.toml
new file mode 100644
index 000000000..4231d0ccc
--- /dev/null
+++ b/web_editor_class_selector/pyproject.toml
@@ -0,0 +1,3 @@
+[build-system]
+requires = ["whool"]
+build-backend = "whool.buildapi"
diff --git a/web_editor_class_selector/readme/DESCRIPTION.md b/web_editor_class_selector/readme/DESCRIPTION.md
new file mode 100644
index 000000000..a3ed4f069
--- /dev/null
+++ b/web_editor_class_selector/readme/DESCRIPTION.md
@@ -0,0 +1,4 @@
+This module allows users to create custom CSS class records, which can
+then be selected and applied directly in the HTML editor. Note: The
+actual CSS file containing the class definitions is not provided by this
+module and must be loaded in a custom module.
diff --git a/web_editor_class_selector/readme/DESCRIPTION.rst b/web_editor_class_selector/readme/DESCRIPTION.rst
deleted file mode 100644
index 72f02eca5..000000000
--- a/web_editor_class_selector/readme/DESCRIPTION.rst
+++ /dev/null
@@ -1,2 +0,0 @@
-This module allows users to create custom CSS class records, which can then be selected and applied directly in the HTML editor.
-Note: The actual CSS file containing the class definitions is not provided by this module and must be loaded in a custom module.
\ No newline at end of file
diff --git a/web_editor_class_selector/readme/ROADMAP.md b/web_editor_class_selector/readme/ROADMAP.md
new file mode 100644
index 000000000..f8a108cda
--- /dev/null
+++ b/web_editor_class_selector/readme/ROADMAP.md
@@ -0,0 +1,2 @@
+Add support to apply class to any element (currently, only span is
+supported)
diff --git a/web_editor_class_selector/readme/ROADMAP.rst b/web_editor_class_selector/readme/ROADMAP.rst
deleted file mode 100644
index ef40b9ac0..000000000
--- a/web_editor_class_selector/readme/ROADMAP.rst
+++ /dev/null
@@ -1 +0,0 @@
-Add support to apply class to any element (currently, only `span` is supported)
\ No newline at end of file
diff --git a/web_editor_class_selector/readme/USAGE.md b/web_editor_class_selector/readme/USAGE.md
new file mode 100644
index 000000000..0400c8fff
--- /dev/null
+++ b/web_editor_class_selector/readme/USAGE.md
@@ -0,0 +1,6 @@
+- Go to Settings \> Technical \> User Interface \> Web editor Class.
+- Create and name your custom CSS classes.
+- Go to any model with an HTML field (e.g., Settings \> Users \>
+ Preferences \> Signature).
+- In the HTML editor, select any content block.
+- Choose from the available CSS classes to apply the desired styling.
diff --git a/web_editor_class_selector/readme/USAGE.rst b/web_editor_class_selector/readme/USAGE.rst
deleted file mode 100644
index d9242875d..000000000
--- a/web_editor_class_selector/readme/USAGE.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-* Go to `Settings` > `Technical` > `User Interface` > `Web editor Class`.
-* Create and name your custom CSS classes.
-* Go to any model with an HTML field (e.g., `Settings` > `Users` > `Preferences` > `Signature`).
-* In the HTML editor, select any content block.
-* Choose from the available CSS classes to apply the desired styling.
diff --git a/web_editor_class_selector/static/description/index.html b/web_editor_class_selector/static/description/index.html
index 11e2cbcc8..7b8cd3e90 100644
--- a/web_editor_class_selector/static/description/index.html
+++ b/web_editor_class_selector/static/description/index.html
@@ -369,9 +369,11 @@ ul.auto-toc {
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:87a4e58b89ecc7f911d8e9fad84c60f0b1a024d6564c5040550651ed2be7ff83
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<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/web/tree/16.0/web_editor_class_selector"><img alt="OCA/web" src="https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/web-16-0/web-16-0-web_editor_class_selector"><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/web&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 module allows users to create custom CSS class records, which can then be selected and applied directly in the HTML editor.
-Note: The actual CSS file containing the class definitions is not provided by this module and must be loaded in a custom module.</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/OCA/web/tree/17.0/web_editor_class_selector"><img alt="OCA/web" src="https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/web-17-0/web-17-0-web_editor_class_selector"><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/web&target_branch=17.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
+<p>This module allows users to create custom CSS class records, which can
+then be selected and applied directly in the HTML editor. Note: The
+actual CSS file containing the class definitions is not provided by this
+module and must be loaded in a custom module.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
@@ -388,23 +390,25 @@ Note: The actual CSS file containing the class definitions is not provided by th
<div class="section" id="usage">
<h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
<ul class="simple">
-<li>Go to <cite>Settings</cite> > <cite>Technical</cite> > <cite>User Interface</cite> > <cite>Web editor Class</cite>.</li>
+<li>Go to Settings > Technical > User Interface > Web editor Class.</li>
<li>Create and name your custom CSS classes.</li>
-<li>Go to any model with an HTML field (e.g., <cite>Settings</cite> > <cite>Users</cite> > <cite>Preferences</cite> > <cite>Signature</cite>).</li>
+<li>Go to any model with an HTML field (e.g., Settings > Users >
+Preferences > Signature).</li>
<li>In the HTML editor, select any content block.</li>
<li>Choose from the available CSS classes to apply the desired styling.</li>
</ul>
</div>
<div class="section" id="known-issues-roadmap">
<h1><a class="toc-backref" href="#toc-entry-2">Known issues / Roadmap</a></h1>
-<p>Add support to apply class to any element (currently, only <cite>span</cite> is supported)</p>
+<p>Add support to apply class to any element (currently, only span is
+supported)</p>
</div>
<div class="section" id="bug-tracker">
<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/OCA/web/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/web/issues/new?body=module:%20web_editor_class_selector%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/OCA/web/issues/new?body=module:%20web_editor_class_selector%0Aversion:%2017.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">
@@ -424,7 +428,7 @@ If you spotted it first, help us to smash it by providing a detailed and welcome
<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/web/tree/16.0/web_editor_class_selector">OCA/web</a> project on GitHub.</p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/web/tree/17.0/web_editor_class_selector">OCA/web</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>
</div>
</div>