reStructuredText — удобный и наглядный язык текстовой разметки, широко применяемый в экосистемах Python и Sphinx.
Заголовки
Подчёркивания (и необязательные верхние линии) задают уровни заголовков:
================
Document Title
================
Section Level 1
===============
Subsection Level 2
------------------
Sub-subsection Level 3
^^^^^^^^^^^^^^^^^^^^^^
Встроенное форматирование
*emphasis (italics)*
**strong emphasis (bold)**
``inline code literal``
`external hyperlink <https://example.com>`_
Списки и таблицы
* 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 |
+------------------+------------------+
Директивы и блоки кода
.. 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.