From 8e7bd89b299ed08a16e377c14f579cefbea96e6e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Krier?= Date: Tue, 20 Dec 2022 14:07:50 +0100 Subject: [PATCH] Replace label by literal in documentation --- modules/account_es/doc/index.rst | 2 +- modules/account_fr/doc/index.rst | 14 ++++---- modules/account_fr_chorus/doc/index.rst | 6 ++-- modules/account_payment/doc/index.rst | 7 ++-- .../account_payment_braintree/doc/index.rst | 6 ++-- modules/account_payment_sepa/doc/index.rst | 14 ++++---- modules/account_payment_stripe/doc/index.rst | 12 +++---- modules/account_statement/doc/index.rst | 10 +++--- modules/account_statement_rule/doc/index.rst | 14 ++++---- modules/authentication_sms/doc/index.rst | 10 +++--- modules/currency_rs/doc/design.rst | 2 +- modules/currency_rs/doc/index.rst | 4 +-- modules/ldap_authentication/doc/index.rst | 8 ++--- modules/marketing_automation/doc/index.rst | 17 +++++----- modules/marketing_email/doc/index.rst | 14 ++++---- modules/notification_email/doc/index.rst | 4 +-- modules/party_relationship/doc/index.rst | 8 ++--- .../product_price_list_parent/doc/index.rst | 2 +- modules/production_work/doc/index.rst | 2 +- modules/stock_lot_unit/doc/index.rst | 3 +- modules/timesheet/doc/user_application.rst | 33 ++++++++++--------- modules/web_shop_vue_storefront/doc/index.rst | 6 ++-- modules/web_shortener/doc/index.rst | 19 ++++++----- modules/web_user/doc/index.rst | 21 ++++++------ 24 files changed, 122 insertions(+), 116 deletions(-) diff --git a/modules/account_es/doc/index.rst b/modules/account_es/doc/index.rst index 63d6fcb72c..f4c73e5adc 100644 --- a/modules/account_es/doc/index.rst +++ b/modules/account_es/doc/index.rst @@ -25,4 +25,4 @@ following commands:: xsltproc --stringparam chart create_chart.xsl account.xml xsltproc --stringparam chart create_chart.xsl tax.xml -where ``chart`` is `normal` or `pyme` +where ``chart`` is ``normal`` or ``pyme``. diff --git a/modules/account_fr/doc/index.rst b/modules/account_fr/doc/index.rst index 2716420d07..099d50431b 100644 --- a/modules/account_fr/doc/index.rst +++ b/modules/account_fr/doc/index.rst @@ -8,13 +8,13 @@ A wizard allows to generate the FEC file for a fiscal year. Configuration ************* -The account_fr module uses the section `account_fr` to retrieve some parameters: +The account_fr module uses the section ``account_fr`` to retrieve some parameters: -- `fec_opening_code`: defines the journal code for the opening balance in the - FEC file. The default value is `OUV`. +- ``fec_opening_code``: defines the journal code for the opening balance in the + FEC file. The default value is ``OUV``. -- `fec_opening_name`: defines the journal name for the opening balance in the - FEC file. The default value is `Balance Initiale`. +- ``fec_opening_name``: defines the journal name for the opening balance in the + FEC file. The default value is ``Balance Initiale``. -- `fec_opening_number`: defines the number of the opening balance in the FEC - file. The default value is `0`. +- ``fec_opening_number``: defines the number of the opening balance in the FEC + file. The default value is ``0``. diff --git a/modules/account_fr_chorus/doc/index.rst b/modules/account_fr_chorus/doc/index.rst index dd6516df18..cc9641183f 100644 --- a/modules/account_fr_chorus/doc/index.rst +++ b/modules/account_fr_chorus/doc/index.rst @@ -11,12 +11,12 @@ the accounting configuration. Configuration ************* -The account_fr_chorus module uses the section `account_fr_chorus` to retrieve +The account_fr_chorus module uses the section ``account_fr_chorus`` to retrieve the path of the SSL certificates. -- `certificate`: the path to the SSL certificate. +- ``certificate``: the path to the SSL certificate. -- `privatekey`: the path to the SSL private key. +- ``privatekey``: the path to the SSL private key. .. warning:: The private key must be unencrypted. diff --git a/modules/account_payment/doc/index.rst b/modules/account_payment/doc/index.rst index b53d922431..b73fd986ee 100644 --- a/modules/account_payment/doc/index.rst +++ b/modules/account_payment/doc/index.rst @@ -21,11 +21,12 @@ amount from a party. It is mainly defined by: - Description. A payment can be created from an payable or receivable *Account Move Line* -using the `Pay Lines` action. The amount is computed from the debit/credit +using the ``Pay Lines`` action. The amount is computed from the debit/credit deducing existing payments for this line. -Direct debit payments can be created from the wizard `Create Direct Debit` for -all the parties that are configured with at least one *Direct Debits* record. +Direct debit payments can be created from the wizard ``Create Direct Debit`` +for all the parties that are configured with at least one *Direct Debits* +record. The payment can be in one of this states: diff --git a/modules/account_payment_braintree/doc/index.rst b/modules/account_payment_braintree/doc/index.rst index 9f8f8c0a68..06e9c68dc1 100644 --- a/modules/account_payment_braintree/doc/index.rst +++ b/modules/account_payment_braintree/doc/index.rst @@ -61,7 +61,7 @@ Configuration ************* The account_payment_braintree module uses the section -`account_payment_braintree` to retrieve some parameters: +``account_payment_braintree`` to retrieve some parameters: -- `payment_methods_cache`: defines the duration in seconds that payment methods - are kept in the cache. The default value is `15 * 60`. +- ``payment_methods_cache``: defines the duration in seconds that payment + methods are kept in the cache. The default value is ``15 * 60``. diff --git a/modules/account_payment_sepa/doc/index.rst b/modules/account_payment_sepa/doc/index.rst index 87ad7142b4..e015bf4bfa 100644 --- a/modules/account_payment_sepa/doc/index.rst +++ b/modules/account_payment_sepa/doc/index.rst @@ -33,7 +33,7 @@ The Journal has some fields when the process method is SEPA: Group ***** -The Group has a field `SEPA Messages` containing the XML messages. +The Group has a field ``SEPA Messages`` containing the XML messages. Mandate ******* @@ -80,18 +80,18 @@ return reason will be stored on it. Party ***** -The Party has a field `SEPA Creditor Identifier` used for the party of the +The Party has a field ``SEPA Creditor Identifier`` used for the party of the company. Configuration ************* -The account_payment_sepa module uses the section `account_payment_sepa` to +The account_payment_sepa module uses the section ``account_payment_sepa`` to retrieve some parameters: -- `filestore`: a boolean value to store SEPA message in the FileStore. - The default value is `False`. +- ``filestore``: a boolean value to store SEPA message in the FileStore. + The default value is ``False``. -- `store_prefix`: the prefix to use with the FileStore. The default value is - `None`. +- ``store_prefix``: the prefix to use with the FileStore. The default value is + ``None``. diff --git a/modules/account_payment_stripe/doc/index.rst b/modules/account_payment_stripe/doc/index.rst index 7cfcbc8e53..786964ccca 100644 --- a/modules/account_payment_stripe/doc/index.rst +++ b/modules/account_payment_stripe/doc/index.rst @@ -63,11 +63,11 @@ It is possible to partially or completely refund a payment. Configuration ************* -The account_payment_stripe module uses the section `account_payment_stripe` to -retrieve some parameters: +The account_payment_stripe module uses the section ``account_payment_stripe`` +to retrieve some parameters: -- `sources_cache`: defines the duration in seconds the sources are kept in the - cache. The default value is `15 * 60`. +- ``sources_cache``: defines the duration in seconds the sources are kept in + the cache. The default value is ``15 * 60``. -- `max_network_retries`: defines the maximum number of retries the Stripe - library may perform. The default value is `3`. +- ``max_network_retries``: defines the maximum number of retries the Stripe + library may perform. The default value is ``3``. diff --git a/modules/account_statement/doc/index.rst b/modules/account_statement/doc/index.rst index 1beb3cee64..a674992b25 100644 --- a/modules/account_statement/doc/index.rst +++ b/modules/account_statement/doc/index.rst @@ -93,11 +93,11 @@ with origins filled. Configuration ************* -The account_statement module uses the section `account_statement` to retrieve +The account_statement module uses the section ``account_statement`` to retrieve some parameters: -- `filestore`: a boolean value to store origin file in the FileStore. - The default value is `False`. +- ``filestore``: a boolean value to store origin file in the FileStore. + The default value is ``False``. -- `store_prefix`: the prefix to use with the FileStore. - The default value is `None`. +- ``store_prefix``: the prefix to use with the FileStore. + The default value is ``None``. diff --git a/modules/account_statement_rule/doc/index.rst b/modules/account_statement_rule/doc/index.rst index c616c9661d..26fdcd4082 100644 --- a/modules/account_statement_rule/doc/index.rst +++ b/modules/account_statement_rule/doc/index.rst @@ -34,8 +34,8 @@ The criteria are matched with each origin of the statement: * Char: A regular expression. * Selection -The regular expression can register the group names `party`, `bank_account` and -`invoice` which are later used to search for a party and an invoice. +The regular expression can register the group names ``party``, ``bank_account`` +and ``invoice`` which are later used to search for a party and an invoice. Lines ----- @@ -43,12 +43,12 @@ Lines They define how to create the statement lines from the matching origin: * Amount: A Python expression evaluated with: - * `amount`: the amount of the origin. - * `pending`: the amount from which previous lines have been deducted. + * ``amount``: the amount of the origin. + * ``pending``: the amount from which previous lines have been deducted. * Party * Account If the party is not filled in, one will be searched for using the -`bank_account` or the `party` group names from the regular expressions. -If the `invoice` group name appears in a regular expression, it will be used to -find an invoice to link with. +``bank_account`` or the ``party`` group names from the regular expressions. +If the ``invoice`` group name appears in a regular expression, it will be used +to find an invoice to link with. diff --git a/modules/authentication_sms/doc/index.rst b/modules/authentication_sms/doc/index.rst index a07b915c76..5cbee2c65a 100644 --- a/modules/authentication_sms/doc/index.rst +++ b/modules/authentication_sms/doc/index.rst @@ -3,11 +3,11 @@ Authentication SMS Module The `SMS `_ authentication module allows users to authenticate via SMS. It adds a new authentication -method `sms`, which can be used in the list of `authentications` in the -`session` section of the configuration file. +method ``sms``, which can be used in the list of ``authentications`` in the +``session`` section of the configuration file. -The `sms` method just sends a code via SMS to the user. Then the user needs to -transcribe the code into the login dialog. +The ``sms`` method just sends a code via SMS to the user. Then the user needs +to transcribe the code into the login dialog. This method requires that the user has the correct *Mobile* phone number defined otherwise it will not be possible for them to authenticate. @@ -15,7 +15,7 @@ defined otherwise it will not be possible for them to authenticate. Configuration ************* -The configuration of the module is set in the `authentication_sms` section. +The configuration of the module is set in the ``authentication_sms`` section. function -------- diff --git a/modules/currency_rs/doc/design.rst b/modules/currency_rs/doc/design.rst index 946a5b2c54..15ce6dd552 100644 --- a/modules/currency_rs/doc/design.rst +++ b/modules/currency_rs/doc/design.rst @@ -10,7 +10,7 @@ Scheduled Rate Updates ====================== When the *Currency RS Module* is activated, the `Serbian National Bank -`_ is added as a source. +`_ is added as a source. If it is selected then only the Serbian Dinar can be used as a base currency. .. seealso:: diff --git a/modules/currency_rs/doc/index.rst b/modules/currency_rs/doc/index.rst index c4de7836c4..4a577cadcd 100644 --- a/modules/currency_rs/doc/index.rst +++ b/modules/currency_rs/doc/index.rst @@ -2,8 +2,8 @@ Currency RS Module ################## -The *Currency RS Module* adds the `Serbian National Bank `_ as -a source for currency exchange rates. +The *Currency RS Module* adds the `Serbian National Bank +`_ as a source for currency exchange rates. .. toctree:: :maxdepth: 2 diff --git a/modules/ldap_authentication/doc/index.rst b/modules/ldap_authentication/doc/index.rst index a900bde483..7a5ec716c6 100644 --- a/modules/ldap_authentication/doc/index.rst +++ b/modules/ldap_authentication/doc/index.rst @@ -3,11 +3,11 @@ LDAP Authentication Module The LDAP authentication module allows to authenticate users via a LDAP server. -The configuration of the LDAP connection is set in the `ldap_authentication` +The configuration of the LDAP connection is set in the ``ldap_authentication`` section. -To be activated, the `ldap` method must be added to the `authentications` -methods list of the `session` section of the configuration. +To be activated, the ``ldap`` method must be added to the ``authentications`` +methods list of the ``session`` section of the configuration. Configuration ************* @@ -34,7 +34,7 @@ The LDAP password used to bind if needed. uid --- -The UID Attribute for authentication (default is `uid`). +The UID Attribute for authentication (default is ``uid``). create_user ----------- diff --git a/modules/marketing_automation/doc/index.rst b/modules/marketing_automation/doc/index.rst index cfc72e176c..9ec0e1c229 100644 --- a/modules/marketing_automation/doc/index.rst +++ b/modules/marketing_automation/doc/index.rst @@ -50,12 +50,12 @@ Send E-Mail The activity send an e-mail to the party defined on the record. The E-mail is composed using an HTML `Genshi `_ -template with `record` in the evaluation context. -All `` elements have their `href` replaced by a shortened version used to -trigger children activities. If the `href` value is `unsubscribe`, it is +template with ``record`` in the evaluation context. +All ```` elements have their ``href`` replaced by a shortened version used +to trigger children activities. If the ``href`` value is ``unsubscribe``, it is replaced by the URL which allows the recipient to block their record for the scenario. -A empty image is automatically added at the end of the `` to track when +A empty image is automatically added at the end of the ```` to track when emails are opened. Record @@ -77,9 +77,10 @@ Configuration The marketing_automation module uses parameters from the section: -- `[marketing]`: +- ``[marketing]``: - - `email_from`: The default `From` for the email. - - `automation_base`: The base URL without a path for the unsubscribe URL + - ``email_from``: The default ``From`` for the email. + - ``automation_base``: The base URL without a path for the unsubscribe URL and the empty image. - The default value is created using the configuration `[web]` `hostname`. + The default value is created using the configuration ``[web]`` + ``hostname``. diff --git a/modules/marketing_email/doc/index.rst b/modules/marketing_email/doc/index.rst index 8a0c94610a..d2f0d28159 100644 --- a/modules/marketing_email/doc/index.rst +++ b/modules/marketing_email/doc/index.rst @@ -46,14 +46,14 @@ Configuration The marketing_email module uses parameters from the section: -- `[marketing]`: +- ``[marketing]``: - - `email_from`: The default `From` for the e-mails that get sent. + - ``email_from``: The default ``From`` for the e-mails that get sent. - - `email_subscribe_url`: the URL to confirm the subscription to which the - parameter `token` will be added. + - ``email_subscribe_url``: the URL to confirm the subscription to which the + parameter ``token`` will be added. - - `email_unsubscribe_url`: the URL to unsubscribe an e-mail address to - which the parameter `token` will be added. + - ``email_unsubscribe_url``: the URL to unsubscribe an e-mail address to + which the parameter ``token`` will be added. - - `email_spy_pixel`: A boolean to activate spy pixel. Disable by default. + - ``email_spy_pixel``: A boolean to activate spy pixel. Disable by default. diff --git a/modules/notification_email/doc/index.rst b/modules/notification_email/doc/index.rst index 26f6a74c9d..d85b5c3e65 100644 --- a/modules/notification_email/doc/index.rst +++ b/modules/notification_email/doc/index.rst @@ -10,7 +10,7 @@ Configuration The notification_email module uses parameters from the section: -- `[notification_email]`: +- ``[notification_email]``: - - `from`: The default `From` for the email. + - ``from``: The default ``From`` for the email. diff --git a/modules/party_relationship/doc/index.rst b/modules/party_relationship/doc/index.rst index a12794b586..0b6ccb9f08 100644 --- a/modules/party_relationship/doc/index.rst +++ b/modules/party_relationship/doc/index.rst @@ -17,9 +17,9 @@ relationship are considered, but this can be limited by adding Configuration ************* -The party_relationship module use the section `party_relationship` to retrieve -some parameters: +The party_relationship module use the section ``party_relationship`` to +retrieve some parameters: -- `depth`: The maximum number of steps to consider when calculating the +- ``depth``: The maximum number of steps to consider when calculating the distance between parties. - The default value is `7`. + The default value is ``7``. diff --git a/modules/product_price_list_parent/doc/index.rst b/modules/product_price_list_parent/doc/index.rst index 637f062fa1..fe5b5a0cae 100644 --- a/modules/product_price_list_parent/doc/index.rst +++ b/modules/product_price_list_parent/doc/index.rst @@ -2,5 +2,5 @@ Product Price List Parent Module ################################ The product_price_list_parent module adds a *Parent* to the price list and the -keyword `parent_unit_price` for the formula which contains the unit price +keyword ``parent_unit_price`` for the formula which contains the unit price computed by the parent price list. diff --git a/modules/production_work/doc/index.rst b/modules/production_work/doc/index.rst index 6748aa6f31..2341702cab 100644 --- a/modules/production_work/doc/index.rst +++ b/modules/production_work/doc/index.rst @@ -10,7 +10,7 @@ Work Center Work center are places in the warehouse where production operations are performed. They can be organized in a tree structure and each center can be linked to a category. A cost can be defined on the work center with two -methods: `Per Cycle` or `Per Hour`. +methods: ``Per Cycle`` or ``Per Hour``. Work **** diff --git a/modules/stock_lot_unit/doc/index.rst b/modules/stock_lot_unit/doc/index.rst index f8858c1371..9e5ac35a49 100644 --- a/modules/stock_lot_unit/doc/index.rst +++ b/modules/stock_lot_unit/doc/index.rst @@ -1,7 +1,8 @@ Stock Lot Unit Module ##################### -The `stock_lot_unit` module allows to define a unit and quantity on stock lot. +The ``stock_lot_unit`` module allows to define a unit and quantity on stock +lot. Lots with unit have the following properties: diff --git a/modules/timesheet/doc/user_application.rst b/modules/timesheet/doc/user_application.rst index 9a3dc9f938..5cb4ac2fd0 100644 --- a/modules/timesheet/doc/user_application.rst +++ b/modules/timesheet/doc/user_application.rst @@ -3,28 +3,29 @@ Timesheet User Application The timesheet module defines some routes for user applications: - - `GET` `//timesheet/employees`: - return the list of the user employees as dictionary with the keys: `id` - and `name`. + - ``GET`` ``//timesheet/employees``: + return the list of the user employees as dictionary with the keys: ``id`` + and ``name``. - - `GET` `//timesheet/employee//works`: + - ``GET`` ``//timesheet/employee//works``: return the list of works available for the employee. The works are - dictionary with keys: `id`, `name`, `start` and `end`. The dates are in - the format `%Y-%m-%d`. + dictionary with keys: ``id``, ``name``, ``start`` and ``end``. The dates + are in the format ``%Y-%m-%d``. - - `GET` `//timesheet/employee//lines/`: + - ``GET`` ``//timesheet/employee//lines/``: return the list of timesheet lines for the employee at the date - (`%Y-%m-%d'). The lines are dictionary with keys: `id`, `work`, - `work.name`, `duration`, `description` and `uuid`. The duration is in - seconds. + (``%Y-%m-%d``). The lines are dictionary with keys: ``id``, ``work``, + ``work.name``, ``duration``, ``description`` and ``uuid``. The duration + is in seconds. - - `POST` `//timesheet/line`: + - ``POST`` ``//timesheet/line``: Create a line using the data as dictionary of value. The date must be in - the format `%Y-%m-%d` and the `duration` in seconds. If a `uuid` value is - provided, it will update the record if found instead of create a new one. + the format ``%Y-%m-%d`` and the ``duration`` in seconds. If a ``uuid`` + value is provided, it will update the record if found instead of create a + new one. - - `PUT` `//timesheet/line/`: - Update the line using the data like for the `POST`. + - ``PUT`` ``//timesheet/line/``: + Update the line using the data like for the ``POST``. - - `DELETE` `//timesheet/line/`: + - ``DELETE`` ``//timesheet/line/``: Delete the line diff --git a/modules/web_shop_vue_storefront/doc/index.rst b/modules/web_shop_vue_storefront/doc/index.rst index 62bc1435bf..8fe74d09b4 100644 --- a/modules/web_shop_vue_storefront/doc/index.rst +++ b/modules/web_shop_vue_storefront/doc/index.rst @@ -11,7 +11,7 @@ Vue StoreFront Configuration ---------------------------- The endpoint must be updated to use the Tryton URL. You must just replace -`/api` by -`http(s)://://web_shop_vue_storefront/`. +``/api`` by +``http(s)://://web_shop_vue_storefront/``. -The configuration `autoRefreshTokens` must be set to `false`. +The configuration ``autoRefreshTokens`` must be set to ``false``. diff --git a/modules/web_shortener/doc/index.rst b/modules/web_shortener/doc/index.rst index 46e65c2325..f34c3a4874 100644 --- a/modules/web_shortener/doc/index.rst +++ b/modules/web_shortener/doc/index.rst @@ -4,22 +4,22 @@ Web Shortener Module The web_shortener module allows URLs to be shortened. It counts the number of times the URL is accessed and optionally triggers action. -The module defines a route `/s/` +The module defines a route ``/s/`` which will redirect the queries to the URL registered previously with -`ShortenedURL.get_url`. +``ShortenedURL.get_url``. Models that need to be callable from a shortened URL must define the method -`shortened_url_execute`. This class method will be called from the underlying +``shortened_url_execute``. This class method will be called from the underlying queue with the record and the keywords arguments transmitted when calling -`get_url`. +``get_url``. Shortened URL ************* - Shortened URL: The shortened URL - Redirect URL: The URL the request is redirected to -- Record: The record on which `method` will be executed -- Method: The name of the method to call on `record` +- Record: The record on which ``method`` will be executed +- Method: The name of the method to call on ``record`` - Count: The number of times this shortened URL has been triggered Configuration @@ -27,7 +27,8 @@ Configuration The web_shortener modules uses the parameter from the section: -- `[web]`: +- ``[web]``: - - `shortener_base`: The base URL without path for shortened URL. - The default value is composed with the configuration `[web]` `hostname`. + - ``shortener_base``: The base URL without path for shortened URL. + The default value is composed with the configuration ``[web]`` + ``hostname``. diff --git a/modules/web_user/doc/index.rst b/modules/web_user/doc/index.rst index 3495e03652..5ddb9e1dd8 100644 --- a/modules/web_user/doc/index.rst +++ b/modules/web_user/doc/index.rst @@ -22,22 +22,23 @@ Configuration The web_user module uses parameters from different sections: -- `web`: +- ``web``: - - `reset_password_url`: the URL to reset the password to which the - parameters `email` and `token` will be added. + - ``reset_password_url``: the URL to reset the password to which the + parameters ``email`` and ``token`` will be added. - - `email_validation_url`: the URL for email validation to which the - parameter `token` will be added. + - ``email_validation_url``: the URL for email validation to which the + parameter ``token`` will be added. -- `email`: +- ``email``: - - `from`: the origin address to send emails. + - ``from``: the origin address to send emails. -- `session`: +- ``session``: - - `web_timeout`: defines in seconds the validity of the web session. + - ``web_timeout``: defines in seconds the validity of the web session. Default: 30 days. - - `web_timeout_reset`: in seconds the validity of the reset password token. + - ``web_timeout_reset``: in seconds the validity of the reset password + token. Default: 1 day.