From 8721637c103cb47ffaad36626376f45a7f5e66df Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Tue, 3 Jul 2018 13:12:04 +0200 Subject: [PATCH 1/2] Improved the configuration references --- reference/configuration/debug.rst | 4 +- reference/configuration/framework.rst | 162 ++++++++++++----------- reference/configuration/swiftmailer.rst | 38 +++--- reference/configuration/twig.rst | 23 ++++ reference/configuration/web_profiler.rst | 8 +- 5 files changed, 133 insertions(+), 102 deletions(-) diff --git a/reference/configuration/debug.rst b/reference/configuration/debug.rst index 2aa9ceb97d7..84fabec3226 100644 --- a/reference/configuration/debug.rst +++ b/reference/configuration/debug.rst @@ -25,9 +25,11 @@ key in your application configuration. Configuration ------------- +.. class:: list-config-options + +* `dump_destination`_ * `max_items`_ * `max_string_length`_ -* `dump_destination`_ max_items ~~~~~~~~~ diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst index 6f03c9d9e88..b9814ef5d6c 100644 --- a/reference/configuration/framework.rst +++ b/reference/configuration/framework.rst @@ -25,96 +25,98 @@ configured under the ``framework`` key in your application configuration. Configuration ------------- -* `secret`_ -* `http_method_override`_ -* `trusted_proxies`_ -* `ide`_ -* `test`_ -* `default_locale`_ -* `trusted_hosts`_ -* :ref:`form ` - * :ref:`enabled ` +.. class:: list-config-options list-config-options--complex + +* `annotations`_ + * :ref:`cache ` + * `debug`_ + * `file_cache_dir`_ +* `assets`_ + * `base_path`_ + * `base_urls`_ + * `packages`_ + * `version_format`_ + * `version`_ * `csrf_protection`_ - * :ref:`enabled ` - * `field_name`_ (deprecated since 2.4) + * :ref:`enabled ` + * `field_name`_ (deprecated since 2.4) +* `default_locale`_ * `esi`_ - * :ref:`enabled ` + * :ref:`enabled ` +* :ref:`form ` + * :ref:`enabled ` * `fragments`_ - * :ref:`enabled ` - * :ref:`path ` + * :ref:`enabled ` + * :ref:`path ` +* `http_method_override`_ +* `ide`_ * `profiler`_ - * :ref:`enabled ` - * `collect`_ - * `only_exceptions`_ - * `only_master_requests`_ - * `dsn`_ - * `username`_ (deprecated since 2.8) - * `password`_ (deprecated since 2.8) - * `lifetime`_ (deprecated since 2.8) - * `matcher`_ - * `ip`_ - * :ref:`path ` - * `service`_ + * `collect`_ + * `dsn`_ + * :ref:`enabled ` + * `lifetime`_ (deprecated since 2.8) + * `matcher`_ + * `ip`_ + * `service`_ + * :ref:`path ` + * `only_exceptions`_ + * `only_master_requests`_ + * `password`_ (deprecated since 2.8) + * `username`_ (deprecated since 2.8) +* `property_access`_ + * `magic_call`_ + * `throw_exception_on_invalid_index`_ * `request`_: - * `formats`_ + * `formats`_ * `router`_ - * `resource`_ - * `type`_ - * `http_port`_ - * `https_port`_ - * `strict_requirements`_ + * `http_port`_ + * `https_port`_ + * `resource`_ + * `strict_requirements`_ + * `type`_ +* `secret`_ +* `serializer`_ + * :ref:`cache ` + * :ref:`enable_annotations ` + * :ref:`enabled ` + * :ref:`name_converter ` * `session`_ - * `storage_id`_ - * `handler_id`_ - * `name`_ - * `cookie_lifetime`_ - * `cookie_path`_ - * `cookie_domain`_ - * `cookie_secure`_ - * `cookie_httponly`_ - * `gc_divisor`_ - * `gc_probability`_ - * `gc_maxlifetime`_ - * `use_strict_mode`_ - * `save_path`_ - * `metadata_update_threshold`_ -* `assets`_ - * `base_path`_ - * `base_urls`_ - * `packages`_ - * `version`_ - * `version_format`_ + * `cookie_domain`_ + * `cookie_httponly`_ + * `cookie_lifetime`_ + * `cookie_path`_ + * `cookie_secure`_ + * `gc_divisor`_ + * `gc_maxlifetime`_ + * `gc_probability`_ + * `handler_id`_ + * `metadata_update_threshold`_ + * `name`_ + * `save_path`_ + * `storage_id`_ + * `use_strict_mode`_ * `templating`_ - * `hinclude_default_template`_ - * :ref:`form ` - * `resources`_ - * :ref:`cache ` - * `engines`_ - * `loaders`_ + * :ref:`cache ` + * `engines`_ + * :ref:`form ` + * `resources`_ + * `hinclude_default_template`_ + * `loaders`_ +* `test`_ * `translator`_ - * :ref:`enabled ` - * `fallbacks`_ - * `logging`_ - * :ref:`paths ` -* `property_access`_ - * `magic_call`_ - * `throw_exception_on_invalid_index`_ + * :ref:`enabled ` + * `fallbacks`_ + * `logging`_ + * :ref:`paths ` +* `trusted_hosts`_ +* `trusted_proxies`_ * `validation`_ - * :ref:`enabled ` - * :ref:`cache ` - * :ref:`enable_annotations ` - * `translation_domain`_ - * `strict_email`_ - * `api`_ -* `annotations`_ - * :ref:`cache ` - * `file_cache_dir`_ - * `debug`_ -* `serializer`_ - * :ref:`enabled ` - * :ref:`cache ` - * :ref:`enable_annotations ` - * :ref:`name_converter ` + * `api`_ + * :ref:`cache ` + * :ref:`enable_annotations ` + * :ref:`enabled ` + * `strict_email`_ + * `translation_domain`_ secret ~~~~~~ diff --git a/reference/configuration/swiftmailer.rst b/reference/configuration/swiftmailer.rst index 3a86894847e..b7b06e15af9 100644 --- a/reference/configuration/swiftmailer.rst +++ b/reference/configuration/swiftmailer.rst @@ -25,29 +25,31 @@ to :doc:`send emails `. All these options are configured under the Configuration ------------- -* `url`_ -* `transport`_ -* `username`_ -* `password`_ -* `command`_ -* `host`_ -* `port`_ -* `timeout`_ -* `source_ip`_ -* `local_domain`_ -* `encryption`_ -* `auth_mode`_ -* `spool`_ - * `type`_ - * `path`_ -* `sender_address`_ +.. class:: list-config-options list-config-options--complex + * `antiflood`_ - * `threshold`_ - * `sleep`_ + * `threshold`_ + * `sleep`_ +* `auth_mode`_ +* `command`_ * `delivery_addresses`_ * `delivery_whitelist`_ * `disable_delivery`_ +* `encryption`_ +* `host`_ +* `local_domain`_ * `logging`_ +* `password`_ +* `port`_ +* `sender_address`_ +* `source_ip`_ +* `spool`_ + * `type`_ + * `path`_ +* `timeout`_ +* `transport`_ +* `url`_ +* `username`_ url ~~~ diff --git a/reference/configuration/twig.rst b/reference/configuration/twig.rst index b6cd3b8d5be..46fd21113f3 100644 --- a/reference/configuration/twig.rst +++ b/reference/configuration/twig.rst @@ -25,6 +25,29 @@ the ``twig`` key in your application configuration. Configuration ------------- +.. class:: list-config-options list-config-options--complex + +* `auto_reload`_ +* `autoescape`_ +* `autoescape_service`_ +* `autoescape_service_method`_ +* `base_template_class`_ +* `cache`_ +* `charset`_ +* `date`_ + * `format`_ + * `interval_format`_ + * `timezone`_ +* `debug`_ +* `exception_controller`_ +* `number_format`_ + * `decimals`_ + * `decimal_point`_ + * `thousands_separator`_ +* `optimizations`_ +* `paths`_ +* `strict_variables`_ + auto_reload ~~~~~~~~~~~ diff --git a/reference/configuration/web_profiler.rst b/reference/configuration/web_profiler.rst index 020f4bce2d4..e5caac67470 100644 --- a/reference/configuration/web_profiler.rst +++ b/reference/configuration/web_profiler.rst @@ -30,10 +30,12 @@ execution and displays it in both the web debug toolbar and the Configuration ------------- -* `toolbar`_ -* `position`_ -* `intercept_redirects`_ +.. class:: list-config-options + * `excluded_ajax_paths`_ +* `intercept_redirects`_ +* `position`_ +* `toolbar`_ * `verbose`_ toolbar From 864d1912aa0d2a93f09baaab6606d11b4432235c Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Tue, 3 Jul 2018 13:48:45 +0200 Subject: [PATCH 2/2] Nested lists in RST must have a blank line above and below --- reference/configuration/framework.rst | 33 +++++++++++++++++++++++++ reference/configuration/swiftmailer.rst | 4 +++ reference/configuration/twig.rst | 4 +++ 3 files changed, 41 insertions(+) diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst index b9814ef5d6c..7d7b6dffeda 100644 --- a/reference/configuration/framework.rst +++ b/reference/configuration/framework.rst @@ -28,59 +28,84 @@ Configuration .. class:: list-config-options list-config-options--complex * `annotations`_ + * :ref:`cache ` * `debug`_ * `file_cache_dir`_ + * `assets`_ + * `base_path`_ * `base_urls`_ * `packages`_ * `version_format`_ * `version`_ + * `csrf_protection`_ + * :ref:`enabled ` * `field_name`_ (deprecated since 2.4) + * `default_locale`_ * `esi`_ + * :ref:`enabled ` + * :ref:`form ` + * :ref:`enabled ` + * `fragments`_ + * :ref:`enabled ` * :ref:`path ` + * `http_method_override`_ * `ide`_ * `profiler`_ + * `collect`_ * `dsn`_ * :ref:`enabled ` * `lifetime`_ (deprecated since 2.8) * `matcher`_ + * `ip`_ * `service`_ * :ref:`path ` + * `only_exceptions`_ * `only_master_requests`_ * `password`_ (deprecated since 2.8) * `username`_ (deprecated since 2.8) + * `property_access`_ + * `magic_call`_ * `throw_exception_on_invalid_index`_ + * `request`_: + * `formats`_ + * `router`_ + * `http_port`_ * `https_port`_ * `resource`_ * `strict_requirements`_ * `type`_ + * `secret`_ * `serializer`_ + * :ref:`cache ` * :ref:`enable_annotations ` * :ref:`enabled ` * :ref:`name_converter ` + * `session`_ + * `cookie_domain`_ * `cookie_httponly`_ * `cookie_lifetime`_ @@ -95,22 +120,30 @@ Configuration * `save_path`_ * `storage_id`_ * `use_strict_mode`_ + * `templating`_ + * :ref:`cache ` * `engines`_ * :ref:`form ` + * `resources`_ + * `hinclude_default_template`_ * `loaders`_ + * `test`_ * `translator`_ + * :ref:`enabled ` * `fallbacks`_ * `logging`_ * :ref:`paths ` + * `trusted_hosts`_ * `trusted_proxies`_ * `validation`_ + * `api`_ * :ref:`cache ` * :ref:`enable_annotations ` diff --git a/reference/configuration/swiftmailer.rst b/reference/configuration/swiftmailer.rst index b7b06e15af9..4be133a697c 100644 --- a/reference/configuration/swiftmailer.rst +++ b/reference/configuration/swiftmailer.rst @@ -28,8 +28,10 @@ Configuration .. class:: list-config-options list-config-options--complex * `antiflood`_ + * `threshold`_ * `sleep`_ + * `auth_mode`_ * `command`_ * `delivery_addresses`_ @@ -44,8 +46,10 @@ Configuration * `sender_address`_ * `source_ip`_ * `spool`_ + * `type`_ * `path`_ + * `timeout`_ * `transport`_ * `url`_ diff --git a/reference/configuration/twig.rst b/reference/configuration/twig.rst index 46fd21113f3..2fdf4de6914 100644 --- a/reference/configuration/twig.rst +++ b/reference/configuration/twig.rst @@ -35,15 +35,19 @@ Configuration * `cache`_ * `charset`_ * `date`_ + * `format`_ * `interval_format`_ * `timezone`_ + * `debug`_ * `exception_controller`_ * `number_format`_ + * `decimals`_ * `decimal_point`_ * `thousands_separator`_ + * `optimizations`_ * `paths`_ * `strict_variables`_