مرجع سريع

ورقة غش reStructuredText (RST)

دليل مرجعي سريع لصياغة reStructuredText (RST): العناوين، التنسيق المضمن، التوجيهات، القوائم، كتل الشيفرة، واتفاقيات Sphinx.

· تاريخ النشر

reStructuredText هي صياغة نصية بسيطة وسهلة القراءة (WYSIWYG نصية) تُستخدم على نطاق واسع في نظام Python ووثائق Sphinx.

العناوين

تحدد التسطيرات السفلية (والعلوية الاختيارية) مستويات العناوين:

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

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

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

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

التنسيق المضمن (Inline)

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

المراجع

موضوعات ذات صلة