Skip to content

Commit b45e6e5

Browse files
committed
Merge branch '6.4' into 7.2
* 6.4: Update documentation format guide
2 parents bbb3e3e + 419978f commit b45e6e5

File tree

1 file changed

+14
-19
lines changed

1 file changed

+14
-19
lines changed

contributing/documentation/format.rst

+14-19
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,17 @@ Documentation Format
22
====================
33

44
The Symfony documentation uses `reStructuredText`_ as its markup language and
5-
`Sphinx`_ for generating the documentation in the formats read by the end users,
6-
such as HTML and PDF.
5+
a custom tool called `Docs Builder`_ for generating the documentation pages.
76

87
reStructuredText
98
----------------
109

1110
reStructuredText is a plain text markup syntax similar to Markdown, but much
12-
stricter with its syntax. If you are new to reStructuredText, take some time to
13-
familiarize with this format by reading the existing `Symfony documentation`_
14-
source code.
11+
stricter with its syntax. If you are new to reStructuredText, check out the
12+
`reStructuredText Primer`_ tutorial and the `reStructuredText Reference`_.
1513

16-
If you want to learn more about this format, check out the `reStructuredText Primer`_
17-
tutorial and the `reStructuredText Reference`_.
14+
You can also take some time to familiarize with this format by reading the
15+
existing `Symfony documentation`_ source.
1816

1917
.. warning::
2018

@@ -24,12 +22,11 @@ tutorial and the `reStructuredText Reference`_.
2422
* Lists start at the beginning of a line (no indentation is allowed);
2523
* Inline code blocks use double-ticks (````like this````).
2624

27-
Sphinx
28-
------
25+
Custom reStructuredText Directives
26+
----------------------------------
2927

30-
Sphinx_ is a build system that provides tools to create documentation from
31-
reStructuredText documents. As such, it adds new directives and interpreted text
32-
roles to the standard reStructuredText markup. Read more about the `Sphinx Markup Constructs`_.
28+
The Symfony documentation includes several custom directives that extend the
29+
standard reStructuredText syntax.
3330

3431
Syntax Highlighting
3532
~~~~~~~~~~~~~~~~~~~
@@ -45,9 +42,9 @@ change it with the ``code-block`` directive:
4542
4643
.. note::
4744

48-
Besides all of the major programming languages, the syntax highlighter
49-
supports all kinds of markup and configuration languages. Check out the
50-
list of `supported languages`_ on the syntax highlighter website.
45+
Code highlighting is supported for all programming languages commonly used
46+
in Symfony Docs, such as ``yaml``, ``xml``, ``twig``, ``html``, ``js``,
47+
``json``, ``text``, ``bash``, ``diff``, etc.
5148

5249
.. _docs-configuration-blocks:
5350

@@ -280,10 +277,8 @@ for Symfony versions that have a lower major version will be removed. For
280277
example, if Symfony 8.0 were released today, 7.0 to 7.4 ``versionadded`` and
281278
``deprecated`` tags would be removed from the new ``8.0`` branch.
282279

283-
.. _reStructuredText: https://docutils.sourceforge.io/rst.html
284-
.. _Sphinx: https://www.sphinx-doc.org/
280+
.. _`reStructuredText`: https://docutils.sourceforge.io/rst.html
281+
.. _`Docs Builder`: https://github.com/symfony-tools/docs-builder
285282
.. _`Symfony documentation`: https://github.com/symfony/symfony-docs
286283
.. _`reStructuredText Primer`: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
287284
.. _`reStructuredText Reference`: https://docutils.sourceforge.io/docs/user/rst/quickref.html
288-
.. _`Sphinx Markup Constructs`: https://www.sphinx-doc.org/en/1.7/markup/index.html
289-
.. _`supported languages`: https://pygments.org/languages/

0 commit comments

Comments
 (0)