@@ -2,19 +2,17 @@ Documentation Format
2
2
====================
3
3
4
4
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.
7
6
8
7
reStructuredText
9
8
----------------
10
9
11
10
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 `_.
15
13
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 .
18
16
19
17
.. warning ::
20
18
@@ -24,12 +22,11 @@ tutorial and the `reStructuredText Reference`_.
24
22
* Lists start at the beginning of a line (no indentation is allowed);
25
23
* Inline code blocks use double-ticks (````like this`` ``).
26
24
27
- Sphinx
28
- ------
25
+ Custom reStructuredText Directives
26
+ ----------------------------------
29
27
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.
33
30
34
31
Syntax Highlighting
35
32
~~~~~~~~~~~~~~~~~~~
@@ -45,9 +42,9 @@ change it with the ``code-block`` directive:
45
42
46
43
.. note ::
47
44
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 .
51
48
52
49
.. _docs-configuration-blocks :
53
50
@@ -280,10 +277,8 @@ for Symfony versions that have a lower major version will be removed. For
280
277
example, if Symfony 8.0 were released today, 7.0 to 7.4 ``versionadded `` and
281
278
``deprecated `` tags would be removed from the new ``8.0 `` branch.
282
279
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
285
282
.. _`Symfony documentation` : https://github.com/symfony/symfony-docs
286
283
.. _`reStructuredText Primer` : https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
287
284
.. _`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