From fbe87b99c85f31ffa0c30cbc5a9a0ba41874c56c Mon Sep 17 00:00:00 2001 From: Juan Jose Pablos Date: Mon, 8 Jul 2024 19:00:26 +0200 Subject: [PATCH] Replace link to configuration document by ref to labels --- modules/account/doc/configuration.rst | 2 +- modules/account_export/doc/configuration.rst | 2 +- modules/account_invoice/doc/configuration.rst | 2 +- modules/account_statement/doc/configuration.rst | 3 +-- modules/authentication_saml/doc/configuration.rst | 7 +++---- modules/currency/doc/configuration.rst | 4 ++-- modules/currency_ro/doc/configuration.rst | 2 +- modules/currency_rs/doc/configuration.rst | 2 +- modules/document_incoming/doc/configuration.rst | 3 +-- modules/inbound_email/doc/configuration.rst | 2 +- modules/marketing_automation/doc/configuration.rst | 6 +++--- modules/product/doc/configuration.rst | 4 ++-- modules/product_image/doc/configuration.rst | 6 ++---- .../product_price_list_dates/doc/configuration.rst | 3 +-- modules/stock_package_shipping/doc/configuration.rst | 3 +-- .../doc/configuration.rst | 3 +-- .../stock_package_shipping_ups/doc/configuration.rst | 3 +-- .../web_shop_product_data_feed/doc/configuration.rst | 3 +-- modules/web_shop_shopify/doc/configuration.rst | 3 +-- modules/web_user/doc/configuration.rst | 4 ++-- trytond/doc/modules/res/design.rst | 4 ++-- trytond/doc/ref/cache.rst | 9 ++++----- trytond/doc/ref/sendmail.rst | 2 +- trytond/doc/topics/configuration.rst | 6 +++--- trytond/doc/topics/setup_database.rst | 4 ++-- trytond/doc/topics/start_server.rst | 11 +++++------ trytond/doc/topics/task_queue.rst | 6 +++--- trytond/doc/tutorial/module/setup_database.rst | 3 +-- 28 files changed, 49 insertions(+), 63 deletions(-) diff --git a/modules/account/doc/configuration.rst b/modules/account/doc/configuration.rst index ac20821ca2..21e1cc12ff 100644 --- a/modules/account/doc/configuration.rst +++ b/modules/account/doc/configuration.rst @@ -3,7 +3,7 @@ Configuration ************* The *Account Module* uses values from settings in the ``[account]`` section -of the :doc:`configuration file `. +of the :ref:`trytond:topics-configuration`. .. _config-account.reconciliation_chunk: diff --git a/modules/account_export/doc/configuration.rst b/modules/account_export/doc/configuration.rst index e496a9a278..a97fd0e895 100644 --- a/modules/account_export/doc/configuration.rst +++ b/modules/account_export/doc/configuration.rst @@ -3,7 +3,7 @@ Configuration ************* The *Account Export Module* uses some settings from the ``[account_export]`` -section of the :doc:`configuration file `. +section of the :ref:`trytond:topics-configuration`. .. _config-account_export.filestore: diff --git a/modules/account_invoice/doc/configuration.rst b/modules/account_invoice/doc/configuration.rst index 7203e0db39..990036f4d7 100644 --- a/modules/account_invoice/doc/configuration.rst +++ b/modules/account_invoice/doc/configuration.rst @@ -3,7 +3,7 @@ Configuration ************* The *Account Invoice Module* uses some settings from the ``[account_invoice]`` -section of the :doc:`configuration file `. +section of the :ref:`trytond:topics-configuration`. .. _config-account_invoice.filestore: diff --git a/modules/account_statement/doc/configuration.rst b/modules/account_statement/doc/configuration.rst index 0bbb89cee3..f594cdf0d5 100644 --- a/modules/account_statement/doc/configuration.rst +++ b/modules/account_statement/doc/configuration.rst @@ -3,8 +3,7 @@ Configuration ************* The *Account Statement Module* uses values from settings in the -``[account_statement]`` section of the :doc:`configuration file -`. +``[account_statement]`` section of the :ref:`trytond:topics-configuration`. .. _config-account_statement.filestore: diff --git a/modules/authentication_saml/doc/configuration.rst b/modules/authentication_saml/doc/configuration.rst index b7bb6c8a4b..64b29225cc 100644 --- a/modules/authentication_saml/doc/configuration.rst +++ b/modules/authentication_saml/doc/configuration.rst @@ -3,8 +3,7 @@ Configuration ************* The *Authentication SAML Module* introduces new authentication services from -settings in the ``[authentication_saml]`` section of the :doc:`configuration -file `. +settings in the ``[authentication_saml]`` section of the :ref:`trytond:topics-configuration`. The section lists the SAML service to setup with the string to display to the user. Each service can be configuration with a section named ``[authentication_saml @@ -22,8 +21,8 @@ Example:: .. note:: Depending on the service provider, you may need to add its origins to the - ``cors`` value in the ``[web]`` section of the :doc:`configuration file - `. + :ref:`config-web.cors` value in the :ref:`config-web` section of the + :ref:`trytond:topics-configuration`. .. _config-authentication_saml.metadata: diff --git a/modules/currency/doc/configuration.rst b/modules/currency/doc/configuration.rst index 223cedd752..b3aab4d38e 100644 --- a/modules/currency/doc/configuration.rst +++ b/modules/currency/doc/configuration.rst @@ -2,8 +2,8 @@ Configuration ************* -The *Currency Module* uses some settings from the ``[currency]`` section of the -:doc:`configuration file `. +The *Currency Module* uses some settings from the ``[currency]`` section of +the :ref:`trytond:topics-configuration` .. _config-currency.rate_decimal: diff --git a/modules/currency_ro/doc/configuration.rst b/modules/currency_ro/doc/configuration.rst index 146c66c671..a94c8b5716 100644 --- a/modules/currency_ro/doc/configuration.rst +++ b/modules/currency_ro/doc/configuration.rst @@ -3,7 +3,7 @@ Configuration ************* The *Currency RO Module* uses values from settings in the ``[currency_ro]`` -section of the :doc:`configuration file `. +section of the :ref:`trytond:topics-configuration`. .. _config-currency_ro.requests_timeout: diff --git a/modules/currency_rs/doc/configuration.rst b/modules/currency_rs/doc/configuration.rst index d4c05f4ddf..1458ea81c1 100644 --- a/modules/currency_rs/doc/configuration.rst +++ b/modules/currency_rs/doc/configuration.rst @@ -3,7 +3,7 @@ Configuration ************* The *Currency RS Module* uses values from settings in the ``[currency_rs]`` -section of the :doc:`configuration file `. +section of the :ref:`trytond:topics-configuration`. .. _config-currency_rs.requests_timeout: diff --git a/modules/document_incoming/doc/configuration.rst b/modules/document_incoming/doc/configuration.rst index 8c3a39bcc2..4e0d40c033 100644 --- a/modules/document_incoming/doc/configuration.rst +++ b/modules/document_incoming/doc/configuration.rst @@ -3,8 +3,7 @@ Configuration ************* The *Document Incoming Module* uses values from settings in the -``[document_incoming]`` section of the :doc:`configuration file -`. +``[document_incoming]`` section of the :ref:`trytond:topics-configuration`. .. _config-document_incoming.filestore: diff --git a/modules/inbound_email/doc/configuration.rst b/modules/inbound_email/doc/configuration.rst index 0717c735ad..d13e31fc2c 100644 --- a/modules/inbound_email/doc/configuration.rst +++ b/modules/inbound_email/doc/configuration.rst @@ -3,7 +3,7 @@ Configuration ************* The *Inbound Email Module* uses values from settings in the ``[inbound_email]`` -section of the :doc:`configuration file `. +section of the :ref:`trytond:topics-configuration`. .. _config-inboud_email.filestore: diff --git a/modules/marketing_automation/doc/configuration.rst b/modules/marketing_automation/doc/configuration.rst index b928ee78fd..e3c50d801c 100644 --- a/modules/marketing_automation/doc/configuration.rst +++ b/modules/marketing_automation/doc/configuration.rst @@ -3,14 +3,14 @@ Configuration ************* The *Marketing Automation Module* uses some settings from the ``[marketing]`` -section of the :doc:`configuration file `. +section of the :ref:`trytond:topics-configuration`. .. _config-marketing.email_from: ``email_from`` ============== -The default email adresse used as ``From`` when sending email. +The default email address used as ``From`` when sending email. The default value is empty. @@ -21,4 +21,4 @@ The default value is empty. The base URL without any path for the unsubscribe URL and the tracking image. -The default value is constricted using the configuration ``hostname``. +The default value is constructed using the configuration :ref:`config-web.hostname`. diff --git a/modules/product/doc/configuration.rst b/modules/product/doc/configuration.rst index 87eb3482cc..031817cfd3 100644 --- a/modules/product/doc/configuration.rst +++ b/modules/product/doc/configuration.rst @@ -2,8 +2,8 @@ Configuration ************* -The *Product Module* uses some settings from the ``[product]`` section of the -:doc:`configuration file `. +The *Product Module* uses some settings from the ``[product]`` section of +the :ref:`trytond:topics-configuration`. .. _config-product.price_decimal: diff --git a/modules/product_image/doc/configuration.rst b/modules/product_image/doc/configuration.rst index cca9febd9d..68078537f8 100644 --- a/modules/product_image/doc/configuration.rst +++ b/modules/product_image/doc/configuration.rst @@ -3,7 +3,7 @@ Configuration ************* The *Product Image Module* uses some settings from the ``[product]`` section of -the :doc:`configuration file `. +the :ref:`trytond:topics-configuration`. .. _config-product-image_filestore: @@ -38,9 +38,7 @@ The default value is: ``2048`` ============== The base URL for the images, without the path. - -The default value is generated from the `hostname -` configuration setting. +The default value is generated from :ref:`config-web.hostname` setting. ``image_timeout`` ================= diff --git a/modules/product_price_list_dates/doc/configuration.rst b/modules/product_price_list_dates/doc/configuration.rst index 516f94e4a9..f721234e91 100644 --- a/modules/product_price_list_dates/doc/configuration.rst +++ b/modules/product_price_list_dates/doc/configuration.rst @@ -3,8 +3,7 @@ Configuration ************* The *Product Price List Dates Module* uses some settings from the -``[product_price_list_dates]`` section of the :doc:`configuration file -`. +``[product_price_list_dates]`` section of the :ref:`trytond:topics-configuration`. .. _config-product_price_list_dates.cache_days: diff --git a/modules/stock_package_shipping/doc/configuration.rst b/modules/stock_package_shipping/doc/configuration.rst index 97fd2d25ff..efbb1dbeff 100644 --- a/modules/stock_package_shipping/doc/configuration.rst +++ b/modules/stock_package_shipping/doc/configuration.rst @@ -3,8 +3,7 @@ Configuration ************* The *Stock Package Shipping Module* uses some settings from the -``[stock_package_shipping]`` section of the :doc:`configuration file -`. +``[stock_package_shipping]`` section of the :ref:`trytond:topics-configuration`. .. _config-stock_package_shipping.filestore: diff --git a/modules/stock_package_shipping_sendcloud/doc/configuration.rst b/modules/stock_package_shipping_sendcloud/doc/configuration.rst index 84e874d2cd..418010c870 100644 --- a/modules/stock_package_shipping_sendcloud/doc/configuration.rst +++ b/modules/stock_package_shipping_sendcloud/doc/configuration.rst @@ -3,8 +3,7 @@ Configuration ************* The *Stock Package Shipping Sendcloud Module* uses values from settings in the -``[stock_package_shipping_sendcloud]`` section of the :doc:`configuration file -`. +``[stock_package_shipping_sendcloud]`` section of the :ref:`trytond:topics-configuration`. .. _config-stock_package_shipping_sendcloud.addresses_cache: diff --git a/modules/stock_package_shipping_ups/doc/configuration.rst b/modules/stock_package_shipping_ups/doc/configuration.rst index 3bfc676392..7b52cc9970 100644 --- a/modules/stock_package_shipping_ups/doc/configuration.rst +++ b/modules/stock_package_shipping_ups/doc/configuration.rst @@ -3,8 +3,7 @@ Configuration ************* The *Stock Package Shipping UPS Module* uses values from the settings in the -``[stock_package_shipping_ups]`` section of the :doc:`configuration file -`. +``[stock_package_shipping_ups]`` section of the :ref:`trytond:topics-configuration`. .. _config-stock_package_shipping_ups.requests_timeout: diff --git a/modules/web_shop_product_data_feed/doc/configuration.rst b/modules/web_shop_product_data_feed/doc/configuration.rst index eb97586d15..f13bb5072d 100644 --- a/modules/web_shop_product_data_feed/doc/configuration.rst +++ b/modules/web_shop_product_data_feed/doc/configuration.rst @@ -3,8 +3,7 @@ Configuration ************* The *Web Shop Product Data Feed Module* uses values from settings in the -``[web_shop]`` section of the :doc:`configuration file -`. +``[web_shop]`` section of the :ref:`trytond:topics-configuration`. .. _config-web_shop.product_data_feed_cache: diff --git a/modules/web_shop_shopify/doc/configuration.rst b/modules/web_shop_shopify/doc/configuration.rst index 73b1d329dd..c4b91e0402 100644 --- a/modules/web_shop_shopify/doc/configuration.rst +++ b/modules/web_shop_shopify/doc/configuration.rst @@ -3,8 +3,7 @@ Configuration ************* The *Web Shop Shopify Module* uses values from settings in the -``[web_shop_shopify]`` section of the :doc:`configuration file -`. +``[web_shop_shopify]`` section of the :ref:`trytond:topics-configuration`. .. _config-web_shop_shopify.locations_cache: diff --git a/modules/web_user/doc/configuration.rst b/modules/web_user/doc/configuration.rst index fd44731a06..06be28cc9c 100644 --- a/modules/web_user/doc/configuration.rst +++ b/modules/web_user/doc/configuration.rst @@ -2,8 +2,8 @@ Configuration ************* -The *Web user Module* uses values from settings in different sections of the -:doc:`configuration file `. +The *Web user Module* uses values from settings in different sections of +the :ref:`trytond:topics-configuration`. ``[web]`` ********* diff --git a/trytond/doc/modules/res/design.rst b/trytond/doc/modules/res/design.rst index 4ce57e794b..d64d41fa5a 100644 --- a/trytond/doc/modules/res/design.rst +++ b/trytond/doc/modules/res/design.rst @@ -109,8 +109,8 @@ Login Attempt The *Login Attempt* concept is used to track and limit login attempts from IP addresses and networks. -It is configured using settings from the ``[session]`` section of the -`configuration file `. +It is configured using settings from the :ref:`config-session` section of the +:ref:`topics-configuration`. .. _model-res.user.device: diff --git a/trytond/doc/ref/cache.rst b/trytond/doc/ref/cache.rst index e7e354d961..437ac12edd 100644 --- a/trytond/doc/ref/cache.rst +++ b/trytond/doc/ref/cache.rst @@ -29,9 +29,9 @@ Cache .. attribute:: Cache.size_limit The maximal number of values cached. - The value comes from the entry with the same ``name`` under the ``cache`` - section of the :ref:`configuration ` using the - ``default`` entry as default value. + The value comes from the entry with the same ``name`` under the + :ref:`config-cache` section of the configuration using the ``default`` entry + as default value. .. attribute:: Cache.hit @@ -89,5 +89,4 @@ Cache By default Tryton uses a MemoryCache, but this behaviour can be overridden by setting a fully qualified name of an alternative class defined in the - :ref:`configuration ` ``class`` of the ``cache`` - section. + ``class`` of the :ref:`config-cache` section. diff --git a/trytond/doc/ref/sendmail.rst b/trytond/doc/ref/sendmail.rst index ec10e7fc51..513b9a2f09 100644 --- a/trytond/doc/ref/sendmail.rst +++ b/trytond/doc/ref/sendmail.rst @@ -46,7 +46,7 @@ Sendmail .. function:: get_smtp_server([uri[, strict]]) Return a SMTP instance from `smtplib`_ using the ``uri`` or the one defined - in the ``email`` section of the :ref:`configuration `. + in the :ref:`config-email.uri` section of the :ref:`config-email` configuration. If strict is ``True``, an exception is raised if it is not possible to connect to the server. diff --git a/trytond/doc/topics/configuration.rst b/trytond/doc/topics/configuration.rst index 85b27bd485..6ffb7d020c 100644 --- a/trytond/doc/topics/configuration.rst +++ b/trytond/doc/topics/configuration.rst @@ -1,8 +1,8 @@ .. _topics-configuration: -============================= -Configuration file for Tryton -============================= +================== +Configuration file +================== The configuration file controls some aspects of the behavior of Tryton. The file uses a simple ini-file format. It consists of sections, led by a diff --git a/trytond/doc/topics/setup_database.rst b/trytond/doc/topics/setup_database.rst index b52a3e050f..c1a48007c0 100644 --- a/trytond/doc/topics/setup_database.rst +++ b/trytond/doc/topics/setup_database.rst @@ -4,8 +4,8 @@ How to setup a database ======================= -The database section of the :ref:`configuration ` must be -set before starting. +The :ref:`config-database` section of the configuration must be set before +starting. Create a database ================= diff --git a/trytond/doc/topics/start_server.rst b/trytond/doc/topics/start_server.rst index b847612e78..03e4ccc294 100644 --- a/trytond/doc/topics/start_server.rst +++ b/trytond/doc/topics/start_server.rst @@ -15,7 +15,7 @@ line: $ trytond -c The server will wait for client connections on the interface defined in the -``web`` section of the :ref:`configuration `. +:ref:`config-web` section of the configuration. .. note:: @@ -35,8 +35,7 @@ If you prefer to run Tryton inside your own WSGI server instead of the simple server of Werkzeug, you can use the application ``trytond.application.app``. Following environment variables can be set: - * ``TRYTOND_CONFIG``: Point to :ref:`configuration ` - file. + * ``TRYTOND_CONFIG``: Point to :ref:`topics-configuration`. * ``TRYTOND_LOGGING_CONFIG``: Point to :ref:`logging ` file. * ``TRYTOND_LOGGING_LEVEL``: An integer to set the default `logging level`_ (default: ``ERROR``). @@ -79,9 +78,9 @@ Worker service ============== If you want to use a pool of workers to run :ref:`asynchronously some tasks -`, you must activate the worker in the ``queue`` section of -the :ref:`configuration ` and run the worker manager with -this command line: +`, you must activate the :ref:`config-queue.worker` in the +:ref:`config-queue` section of the configuration and run the worker manager +with this command line: .. code-block:: console diff --git a/trytond/doc/topics/task_queue.rst b/trytond/doc/topics/task_queue.rst index c7886a9598..de25f47611 100644 --- a/trytond/doc/topics/task_queue.rst +++ b/trytond/doc/topics/task_queue.rst @@ -5,9 +5,9 @@ Task Queue ========== Tryton provides a way to run asynchronously some tasks. You must activate the -worker in the ``queue`` section of the :ref:`configuration -` and :ref:`run the worker manager -` otherwise the tasks will be run at the end of the +:ref:`config-queue.worker` in the :ref:`config-queue` section of the configuration +and :ref:`run the worker manager ` otherwise the +tasks will be run at the end of the transaction. A task is the parameters that defines how to call a method from a diff --git a/trytond/doc/tutorial/module/setup_database.rst b/trytond/doc/tutorial/module/setup_database.rst index e593826af2..ce2faa0ac7 100644 --- a/trytond/doc/tutorial/module/setup_database.rst +++ b/trytond/doc/tutorial/module/setup_database.rst @@ -5,8 +5,7 @@ Initialize the database By default Tryton, use an SQLite database stored in the folder :file:`db` of your home directory. -This can be changed in the ``database`` section of the `configuration -`. +This can be changed in the :ref:`config-database` section of the configuration. Now creating a Tryton database is only a matter of executing the following commands: