From f2b6e0798e266fe9ea0a941982362fb8bcccd8a0 Mon Sep 17 00:00:00 2001 From: Akim Juillerat Date: Tue, 29 May 2018 15:48:19 +0200 Subject: [PATCH] Update readme for generator --- configuration_helper/README.rst | 58 -------------------- configuration_helper/readme/CONTRIBUTORS.rst | 4 ++ configuration_helper/readme/DESCRIPTION.rst | 11 ++++ configuration_helper/readme/ROADMAP.rst | 2 + configuration_helper/readme/USAGE.rst | 13 +++++ 5 files changed, 30 insertions(+), 58 deletions(-) delete mode 100644 configuration_helper/README.rst create mode 100644 configuration_helper/readme/CONTRIBUTORS.rst create mode 100644 configuration_helper/readme/DESCRIPTION.rst create mode 100644 configuration_helper/readme/ROADMAP.rst create mode 100644 configuration_helper/readme/USAGE.rst diff --git a/configuration_helper/README.rst b/configuration_helper/README.rst deleted file mode 100644 index 7592001f1..000000000 --- a/configuration_helper/README.rst +++ /dev/null @@ -1,58 +0,0 @@ -.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg - :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html - :alt: License: AGPL-3 - -==================== -Configuration Helper -==================== - -*This module is intended for developer only. It does nothing used alone.* - -It helps to create `config.settings` by providing an abstract Class. - -This class: - - * creates automatically related fields in 'whatiwant.config.settings' - using those defined in 'res.company': it avoids duplicated field definitions. - * company_id field with default value is created - * onchange_company_id is defined to update all related fields - * supported fields: char, text, integer, float, datetime, date, boolean, m2o - - -How to use ----------- - -.. code-block:: python - - from . company import ResCompany - - class WhatiwantClassSettings(orm.TransientModel): - _inherit = ['res.config.settings', 'abstract.config.settings'] - _name = 'whatiwant.config.settings' - # fields must be defined in ResCompany class - # related fields are automatically generated from previous definitions - _companyObject = ResCompany - # all prefixed field with _prefix in res.company, will be available in 'whatiwant.config.settings' model - _prefix = 'prefixyouchoose_' - - -Roadmap -------- - * support (or check support) for these field types : o2m, m2m, reference, property, selection - * automatically generate a default view for 'whatiwant.config.settings' (in --debug ?) - -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 smashing it by providing a detailed and welcomed feedback. - -Contributors ------------- - -* Yannick Vaucher -* David BEAL -* Sébastien BEAU -* Angel Moya diff --git a/configuration_helper/readme/CONTRIBUTORS.rst b/configuration_helper/readme/CONTRIBUTORS.rst new file mode 100644 index 000000000..31198d249 --- /dev/null +++ b/configuration_helper/readme/CONTRIBUTORS.rst @@ -0,0 +1,4 @@ +* Yannick Vaucher +* David BEAL +* Sébastien BEAU +* Angel Moya \ No newline at end of file diff --git a/configuration_helper/readme/DESCRIPTION.rst b/configuration_helper/readme/DESCRIPTION.rst new file mode 100644 index 000000000..7d420e61a --- /dev/null +++ b/configuration_helper/readme/DESCRIPTION.rst @@ -0,0 +1,11 @@ +*This module is intended for developer only. It does nothing used alone.* + +It helps to create `config.settings` by providing an abstract Class. + +This class: + + * creates automatically related fields in 'whatiwant.config.settings' + using those defined in 'res.company': it avoids duplicated field definitions. + * company_id field with default value is created + * onchange_company_id is defined to update all related fields + * supported fields: char, text, integer, float, datetime, date, boolean, m2o diff --git a/configuration_helper/readme/ROADMAP.rst b/configuration_helper/readme/ROADMAP.rst new file mode 100644 index 000000000..71d14010e --- /dev/null +++ b/configuration_helper/readme/ROADMAP.rst @@ -0,0 +1,2 @@ + * support (or check support) for these field types : o2m, m2m, reference, property, selection + * automatically generate a default view for 'whatiwant.config.settings' (in --debug ?) diff --git a/configuration_helper/readme/USAGE.rst b/configuration_helper/readme/USAGE.rst new file mode 100644 index 000000000..231d01be0 --- /dev/null +++ b/configuration_helper/readme/USAGE.rst @@ -0,0 +1,13 @@ +.. code-block:: python + + from . company import ResCompany + + class WhatiwantClassSettings(orm.TransientModel): + _inherit = ['res.config.settings', 'abstract.config.settings'] + _name = 'whatiwant.config.settings' + # fields must be defined in ResCompany class + # related fields are automatically generated from previous definitions + _companyObject = ResCompany + # all prefixed field with _prefix in res.company, will be available in 'whatiwant.config.settings' model + _prefix = 'prefixyouchoose_' +