Skip to content

Commit bf64fc9

Browse files
committed
Update documentation format guide
1 parent 548b0cd commit bf64fc9

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

contributing/documentation/format.rst

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,11 @@ tutorial and the `reStructuredText Reference`_.
2424
* Lists start at the beginning of a line (no indentation is allowed);
2525
* Inline code blocks use double-ticks (````like this````).
2626

27-
Sphinx
28-
------
27+
Custom reStructuredText Directives
28+
----------------------------------
2929

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`_.
30+
Symfony Docs include custom directives on top of the standard reStructuredText
31+
to suit our needs.
3332

3433
Syntax Highlighting
3534
~~~~~~~~~~~~~~~~~~~
@@ -45,9 +44,9 @@ change it with the ``code-block`` directive:
4544
4645
.. note::
4746

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.
47+
Code highlighting is support for all the programming languages commonly used
48+
in Symfony Docs: ``yaml``, ``xml``, ``twig``, ``html``, ``js``, ``json``,
49+
``text``, ``bash``, ``diff``, etc.
5150

5251
.. _docs-configuration-blocks:
5352

@@ -281,9 +280,6 @@ example, if Symfony 6.0 were released today, 5.0 to 5.4 ``versionadded`` and
281280
``deprecated`` tags would be removed from the new ``6.0`` branch.
282281

283282
.. _reStructuredText: https://docutils.sourceforge.io/rst.html
284-
.. _Sphinx: https://www.sphinx-doc.org/
285283
.. _`Symfony documentation`: https://github.com/symfony/symfony-docs
286284
.. _`reStructuredText Primer`: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
287285
.. _`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)