8000 minor #10000 Improved the configuration references (javiereguiluz) · symfony/symfony-docs@7b2dafc · GitHub
[go: up one dir, main page]
Skip to content

Commit 7b2dafc

Browse files
javiereguiluzjaviereguiluz
committed
minor #10000 Improved the configuration references (javiereguiluz)
This PR was squashed before being merged into the 2.8 branch (closes #10000). Discussion ---------- Improved the configuration references Changes done: * Added the missing options listing for TwigBundle * Fixed indenting of sub-options (they were being generated as `<ul> + <dl> + <ul>` instead of `<ul> + <ul>`) * Sorted lists of options alphabetically (very important for readers, especially for long lists of options. As we talked in the past, we only sort the list of options, not the option descriptions ... to avoid all the merging nightmares). * Added some CSS classes to all the config option lists (so we can later improve how they look on symfony.com) Commits ------- 0c187e9 Improved the configuration references
2 parents 23118f7 + 0c187e9 commit 7b2dafc

File tree

5 files changed

+174
-102
lines changed

5 files changed

+174
-102
lines changed

‎reference/configuration/debug.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,11 @@ key in your application configuration.
2525
Configuration
2626
-------------
2727

28+
.. class:: list-config-options
29+
30+
* `dump_destination`_
2831
* `max_items`_
2932
* `max_string_length`_
30-
* `dump_destination`_
3133

3234
max_items
3335
~~~~~~~~~

‎reference/configuration/framework.rst

Lines changed: 115 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -25,96 +25,131 @@ configured under the ``framework`` key in your application configuration.
2525
Configuration
2626
-------------
2727

28-
* `secret`_
29-
* `http_method_override`_
30-
* `trusted_proxies`_
31-
* `ide`_
32-
* `test`_
33-
* `default_locale`_
34-
* `trusted_hosts`_
35-
* :ref:`form <reference-framework-form>`
36-
* :ref:`enabled <reference-form-enabled>`
28+
.. class:: list-config-options list-config-options--complex
29+
30+
* `annotations`_
31+
32+
* :ref:`cache <reference-annotations-cache>`
33+
* `debug`_
34+
* `file_cache_dir`_
35+
36+
* `assets`_
37+
38+
* `base_path`_
39+
* `base_urls`_
40+
* `packages`_
41+
* `version_format`_
42+
* `version`_
43+
3744
* `csrf_protection`_
38-
* :ref:`enabled <reference-csrf_protection-enabled>`
39-
* `field_name`_ (deprecated since 2.4)
45+
46+
* :ref:`enabled <reference-csrf_protection-enabled>`
47+
* `field_name`_ (deprecated since 2.4)
48+
49+
* `default_locale`_
4050
* `esi`_
41-
* :ref:`enabled <reference-esi-enabled>`
51+
52+
* :ref:`enabled <reference-esi-enabled>`
53+
54+
* :ref:`form <reference-framework-form>`
55+
56+
* :ref:`enabled <reference-form-enabled>`
57+
4258
* `fragments`_
43-
* :ref:`enabled <reference-fragments-enabled>`
44-
* :ref:`path <reference-fragments-path>`
59+
60+
* :ref:`enabled <reference-fragments-enabled>`
61+
* :ref:`path <reference-fragments-path>`
62+
63+
* `http_method_override`_
64+
* `ide`_
4565
* `profiler`_
46-
* :ref:`enabled <reference-profiler-enabled>`
47-
* `collect`_
48-
* `only_exceptions`_
49-
* `only_master_requests`_
50-
* `dsn`_
51-
* `username`_ (deprecated since 2.8)
52-
* `password`_ (deprecated since 2.8)
53-
* `lifetime`_ (deprecated since 2.8)
54-
* `matcher`_
55-
* `ip`_
56-
* :ref:`path <reference-profiler-matcher-path>`
57-
* `service`_
66+
67+
* `collect`_
68+
* `dsn`_
69+
* :ref:`enabled <reference-profiler-enabled>`
70+
* `lifetime`_ (deprecated since 2.8)
71+
* `matcher`_
72+
73+
* `ip`_
74+
* `service`_
75+
* :ref:`path <reference-profiler-matcher-path>`
76+
77+
* `only_exceptions`_
78+
* `only_master_requests`_
79+
* `password`_ (deprecated since 2.8)
80+
* `username`_ (deprecated since 2.8)
81+
82+
* `property_access`_
83+
84+
* `magic_call`_
85+
* `throw_exception_on_invalid_index`_
86+
5887
* `request`_:
59-
* `formats`_
88+
89+
* `formats`_
90+
6091
* `router`_
61-
* `resource`_
62-
* `type`_
63-
* `http_port`_
64-
* `https_port`_
65-
* `strict_requirements`_
92+
93+
* `http_port`_
94+
* `https_port`_
95+
* `resource`_
96+
* `strict_requirements`_
97+
* `type`_
98+
99+
* `secret`_
100+
* `serializer`_
101+
102+
* :ref:`cache <reference-serializer-cache>`
103+
* :ref:`enable_annotations <reference-serializer-enable_annotations>`
104+
* :ref:`enabled <reference-serializer-enabled>`
105+
* :ref:`name_converter <reference-serializer-name_converter>`
106+
66107
* `session`_
67-
* `storage_id`_
68-
* `handler_id`_
69-
* `name`_
70-
* `cookie_lifetime`_
71-
* `cookie_path`_
72-
* `cookie_domain`_
73-
* `cookie_secure`_
74-
* `cookie_httponly`_
75-
* `gc_divisor`_
76-
* `gc_probability`_
77-
* `gc_maxlifetime`_
78-
* `use_strict_mode`_
79-
* `save_path`_
80-
* `metadata_update_threshold`_
81-
* `assets`_
82-
* `base_path`_
83-
* `base_urls`_
84-
* `packages`_
85-
* `version`_
86-
* `version_format`_
108+
109+
* `cookie_domain`_
110+
* `cookie_httponly`_
111+
* `cookie_lifetime`_
112+
* `cookie_path`_
113+
* `cookie_secure`_
114+
* `gc_divisor`_
115+
* `gc_maxlifetime`_
116+
* `gc_probability`_
117+
* `handler_id`_
118+
* `metadata_update_threshold`_
119+
* `name`_
120+
* `save_path`_
121+
* `storage_id`_
122+
* `use_strict_mode`_
123+
87124
* `templating`_
88-
* `hinclude_default_template`_
89-
* :ref:`form <reference-templating-form>`
90-
* `resources`_
91-
* :ref:`cache <reference-templating-cache>`
92-
* `engines`_
93-
* `loaders`_
125+
126+
* :ref:`cache <reference-templating-cache>`
127+
* `engines`_
128+
* :ref:`form <reference-templating-form>`
129+
130+
* `resources`_
131+
132+
* `hinclude_default_template`_
133+
* `loaders`_
134+
135+
* `test`_
94136
* `translator`_
95-
* :ref:`enabled <reference-translator-enabled>`
96-
* `fallbacks`_
97-
* `logging`_
98-
* :ref:`paths <reference-translator-paths>`
99-
* `property_access`_
100-
* `magic_call`_
101-
* `throw_exception_on_invalid_index`_
137+
138+
* :ref:`enabled <reference-translator-enabled>`
139+
* `fallbacks`_
140+
* `logging`_
141+
* :ref:`paths <reference-translator-paths>`
142+
143+
* `trusted_hosts`_
144+
* `trusted_proxies`_
102145
* `validation`_
103-
* :ref:`enabled <reference-validation-enabled>`
104-
* :ref:`cache <reference-validation-cache>`
105-
* :ref:`enable_annotations <reference-validation-enable_annotations>`
106-
* `translation_domain`_
107-
* `strict_email`_
108-
* `api`_
109-
* `annotations`_
110-
* :ref:`cache <reference-annotations-cache>`
111-
* `file_cache_dir`_
112-
* `debug`_
113-
* `serializer`_
114-
* :ref:`enabled <reference-serializer-enabled>`
115-
* :ref:`cache <reference-serializer-cache>`
116-
* :ref:`enable_annotations <reference-serializer-enable_annotations>`
117-
* :ref:`name_converter <reference-serializer-name_converter>`
146+
147+
* `api`_
148+
* :ref:`cache <reference-validation-cache>`
149+
* :ref:`enable_annotations <reference-validation-enable_annotations>`
150+
* :ref:`enabled <reference-validation-enabled>`
151+
* `strict_email`_
152+
* `translation_domain`_
118153

119154
secret
120155
~~~~~~

‎reference/configuration/swiftmailer.rst

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -25,29 +25,35 @@ to :doc:`send emails </email>`. All these options are configured under the
2525
Configuration
2626
-------------
2727

28-
* `url`_
29-
* `transport`_
30-
* `username`_
31-
* `password`_
32-
* `command`_
33-
* `host`_
34-
* `port`_
35-
* `timeout`_
36-
* `source_ip`_
37-
* `local_domain`_
38-
* `encryption`_
39-
* `auth_mode`_
40-
* `spool`_
41-
* `type`_
42-
* `path`_
43-
* `sender_address`_
28+
.. class:: list-config-options list-config-options--complex
29+
4430
* `antiflood`_
45-
* `threshold`_
46-
* `sleep`_
31+
32+
* `threshold`_
33+
* `sleep`_
34+
35+
* `auth_mode`_
36+
* `command`_
4737
* `delivery_addresses`_
4838
* `delivery_whitelist`_
4939
* `disable_delivery`_
40+
* `encryption`_
41+
* `host`_
42+
* `local_domain`_
5043
* `logging`_
44+
* `password`_
45+
* `port`_
46+
* `sender_address`_
47+
* `source_ip`_
48+
* `spool`_
49+
50+
* `type`_
51+
* `path`_
52+
53+
* `timeout`_
54+
* `transport`_
55+
* `url`_
56+
* `username`_
5157

5258
url
5359
~~~

‎reference/configuration/twig.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,33 @@ the ``twig`` key in your application configuration.
2525
Configuration
2626
-------------
2727

28+
.. class:: list-config-options list-config-options--complex
29+
30+
* `auto_reload`_
31+
* `autoescape`_
32+
* `autoescape_service`_
33+
* `autoescape_service_method`_
34+
* `base_template_class`_
35+
* `cache`_
36+
* `charset`_
37+
* `date`_
38+
39+
* `format`_
40+
* `interval_format`_
41+
* `timezone`_
42+
43+
* `debug`_
44+
* `exception_controller`_
45+
* `number_format`_
46+
47+
* `decimals`_
48+
* `decimal_point`_
49+
* `thousands_separator`_
50+
51+
* `optimizations`_
52+
* `paths`_
53+
* `strict_variables`_
54+
2855
auto_reload
2956
~~~~~~~~~~~
3057

‎reference/configuration/web_profiler.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,12 @@ execution and displays it in both the web debug toolbar and the
3030
Configuration
3131
-------------
3232

33-
* `toolbar`_
34-
* `position`_
35-
* `intercept_redirects`_
33+
.. class:: list-config-options
34+
3635
* `excluded_ajax_paths`_
36+
* `intercept_redirects`_
37+
* `position`_
38+
* `toolbar`_
3739
* `verbose`_
3840

3941
toolbar

0 commit comments

Comments
 (0)
0