Skip to content

Commit aaf290a

Browse files
committed
Merge branch '5.4' into 6.3
* 5.4: [Contributing] Document :ref: links
2 parents 1d77342 + 162d5c2 commit aaf290a

File tree

1 file changed

+37
-7
lines changed

1 file changed

+37
-7
lines changed

contributing/documentation/format.rst

Lines changed: 37 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -110,18 +110,25 @@ The current list of supported formats are the following:
110110
=================== ==============================================================================
111111
Markup Format Use It to Display
112112
=================== ==============================================================================
113-
``html`` HTML
114-
``xml`` XML
115-
``php`` PHP
116-
``yaml`` YAML
117-
``twig`` Pure Twig markup
118-
``html+twig`` Twig markup blended with HTML
113+
``caddy`` Caddy web server configuration
114+
``env`` Bash files (like ``.env`` files)
119115
``html+php`` PHP code blended with HTML
116+
``html+twig`` Twig markup blended with HTML
117+
``html`` HTML
120118
``ini`` INI
121119
``php-annotations`` PHP Annotations
122120
``php-attributes`` PHP Attributes
123-
``php-symfony`` PHP code example when using the Symfony framework
124121
``php-standalone`` PHP code to be used in any PHP application using standalone Symfony components
122+
``php-symfony`` PHP code example when using the Symfony framework
123+
``php`` PHP
124+
``rst`` reStructuredText markup
125+
``terminal`` Renders the contents as a console terminal (use it to show which commands to run)
126+
``twig`` Pure Twig markup
127+
``varnish3`` Varnish Cache 3 configuration
128+
``varnish4`` Varnish Cache 4 configuration
129+
``vcl`` Varnish Configuration Language
130+
``xml`` XML
131+
``yaml`` YAML
125132
=================== ==============================================================================
126133

127134
Displaying Tabs
@@ -190,6 +197,29 @@ If you want to modify that title, use this alternative syntax:
190197
191198
:doc:`environments`
192199
200+
**Links to specific page sections** follow a different syntax. First, define a
201+
target above section you will link to (syntax: ``.. _`` + target name + ``:``):
202+
203+
.. code-block:: rst
204+
205+
# /service_container/autowiring.rst
206+
207+
# define the target
208+
.. _autowiring-calls:
209+
210+
Autowiring other Methods (e.g. Setters and Public Typed Properties)
211+
-------------------------------------------------------------------
212+
213+
// section content ...
214+
215+
Then, use the ``:ref::`` directive to link to that section from another file:
216+
217+
.. code-block:: rst
218+
219+
# /reference/attributes.rst
220+
221+
:ref:`Required <autowiring-calls>`
222+
193223
**Links to the API** follow a different syntax, where you must specify the type
194224
of the linked resource (``class`` or ``method``):
195225

0 commit comments

Comments
 (0)