Référence rapide

Aide-mémoire reStructuredText (RST)

Guide rapide pour reStructuredText (RST) : titres, balisage en ligne, directives, listes, blocs de code et conventions Sphinx.

· Publié le

reStructuredText est une syntaxe de balisage en texte brut très lisible, largement utilisée dans Python et Sphinx.

Titres

Les soulignements (et surlignements optionnels) définissent les niveaux de titre :

================
Document Title
================

Section Level 1
===============

Subsection Level 2
------------------

Sub-subsection Level 3
^^^^^^^^^^^^^^^^^^^^^^

Formatage en ligne

*emphasis (italics)*
**strong emphasis (bold)**
``inline code literal``
`external hyperlink <https://example.com>`_

Listes et tableaux

* Bullet item 1
* Bullet item 2

1. Numbered item 1
2. Numbered item 2

+------------------+------------------+
| Header Column 1  | Header Column 2  |
+==================+==================+
| Cell 1, 1        | Cell 1, 2        |
+------------------+------------------+

Directives et blocs de code

.. code-block:: python
    :linenos:

    def greet(name):
        return f"Hello, {name}!"

.. note::
    This is an informational callout note.

.. warning::
    This is a critical warning message.

Références

Sujets associés