빠른 참조

reStructuredText (RST) 치트시트

reStructuredText(RST) 빠른 참조 가이드: 제목 기호, 인라인 마크업, 지시문, 목록, 표, 코드 블록 및 Sphinx 규칙을 정리합니다.

· 게시일

reStructuredText는 Python과 Sphinx 문서 생태계에서 널리 사용되는 직관적인 플레인 텍스트 마크업 문법입니다.

제목 (Headings)

밑줄(및 선택적 윗줄) 기호로 제목 수준을 정의합니다:

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

참고 자료

관련 주제