Riferimento rapido

Cheat Sheet per reStructuredText (RST)

Guida rapida per reStructuredText (RST): titoli, formattazione inline, direttive, elenchi, blocchi di codice e convenzioni Sphinx.

· Pubblicato

reStructuredText è una sintassi di markup in testo semplice leggibile, ampiamente adottata negli ecosistemi Python e Sphinx.

Titoli

Le sottolineature (e le linee superiori opzionali) definiscono i livelli dei titoli:

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

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

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

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

Formattazione inline

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

Elenchi e tabelle

* 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        |
+------------------+------------------+

Direttive e blocchi di codice

.. 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.

Riferimenti

Argomenti correlati