Skip to content

Commit 97f56b0

Browse files
committed
-
1 parent 7013e62 commit 97f56b0

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

contributing/documentation/format.rst

Lines changed: 7 additions & 8 deletions
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

@@ -278,7 +276,8 @@ for Symfony versions that have a lower major version will be removed. For
278276
example, if Symfony 6.0 were released today, 5.0 to 5.4 ``versionadded`` and
279277
``deprecated`` tags would be removed from the new ``6.0`` branch.
280278

281-
.. _reStructuredText: https://docutils.sourceforge.io/rst.html
279+
.. _`reStructuredText`: https://docutils.sourceforge.io/rst.html
280+
.. _`Docs Builder`: https://github.com/symfony-tools/docs-builder
282281
.. _`Symfony documentation`: https://github.com/symfony/symfony-docs
283282
.. _`reStructuredText Primer`: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
284283
.. _`reStructuredText Reference`: https://docutils.sourceforge.io/docs/user/rst/quickref.html

0 commit comments

Comments
 (0)