Referință rapidă

Fișă de referință reStructuredText (RST)

Ghid rapid pentru reStructuredText (RST): titluri, marcaj inline, directive, liste, blocuri de cod și convenții Sphinx.

· Publicat

reStructuredText este o sintaxă de marcare text simplu ușor de citit, utilizată pe scară largă în ecosistemul Python și Sphinx.

Titluri

Sublinierile (și liniile deasupra opționale) definesc nivelurile de titlu:

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

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

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

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

Formatare inline

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

Liste și tabele

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

Directive și blocuri de cod

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

Referințe

Subiecte conexe