*emphasis* | 이탤릭 텍스트 |
**strong emphasis** | 굵은 텍스트 |
``inline literal`` | 인라인 코드 |
`interpreted text` | 해석된 텍스트 (역할) |
:role:`text` | 명시적 이름 있는 역할 |
|substitution| | 치환 참조 |
_`inline target` | 인라인 타겟 |
`link text`_ | 하이퍼링크 참조 |
======
Title
====== | 제목 (상/하단 라인) |
Section
======= | 섹션 (하단 라인) |
Subsection
---------- | 서브섹션 |
Subsubsection
^^^^^^^^^^^^ | 서브서브섹션 |
Paragraph
""""""""" | 문단 |
* Item 1
* Item 2 | 글머리 기호 목록 |
- Item 1
- Item 2 | 글머리 기호 목록 (대시) |
1. First
2. Second | 번호 목록 |
#. Auto-numbered | 자동 번호 목록 |
term
Definition | 정의 목록 |
:field: value | 필드 목록 |
-a option a
-b option b | 옵션 목록 |
::
code block | 리터럴 블록 |
text::
code | 문단 연결 블록 |
.. code-block:: python
code | 구문 강조 코드 블록 |
>>> print("hello")
hello | Doctest 블록 |
Indented paragraph | 블록 인용 |
| Line 1
| Line 2 | 줄 블록 |
-- Attribution | 출처 |
https://example.com | 독립 URL |
`Link text <https://url>`_ | 인라인 링크 |
`Link text`_
.. _Link text: url | 명명된 참조 |
`anonymous link`__
__ url | 익명 링크 |
section_
.. _section: | 내부 참조 |
:ref:`label` | 라벨 참조 |
:doc:`document` | 문서 참조 |
:py:func:`function` | Python 함수 참조 |
:py:class:`Class` | Python 클래스 참조 |
:py:mod:`module` | Python 모듈 참조 |
:download:`file.zip` | 다운로드 파일 |
text [1]_
.. [1] Footnote text | 번호 각주 |
text [#]_
.. [#] Auto footnote | 자동 번호 각주 |
text [#name]_
.. [#name] Named | 명명된 자동 각주 |
text [*]_
.. [*] Symbol footnote | 기호 각주 |
[citation]_
.. [citation] Citation text | 인용 |
.. note::
Note text | 노트 |
.. warning::
Warning text | 경고 |
.. tip::
Tip text | 팁 |
.. important::
Important text | 중요 |
.. danger::
Danger text | 위험 |
.. seealso::
See also text | 참고 |
.. image:: path/image.png | 이미지 |
.. figure:: path/image.png
:caption: Caption | 캡션 있는 그림 |
.. contents:: | 목차 |
.. toctree::
:maxdepth: 2
doc1
doc2 | TOC 트리 |
.. include:: filename.rst | 파일 포함 |
.. raw:: html
<br> | 원시 콘텐츠 |
.. image:: img.png
:width: 200px | 너비 옵션 |
.. image:: img.png
:height: 100px | 높이 옵션 |
.. image:: img.png
:scale: 50% | 스케일 옵션 |
.. image:: img.png
:alt: Alt text | 대체 텍스트 옵션 |
.. image:: img.png
:align: center | 정렬 옵션 |
+-------+-------+
| A | B |
+=======+=======+
| 1 | 2 |
+-------+-------+ | 그리드 테이블 |
===== =====
A B
===== =====
1 2
===== ===== | 단순 테이블 |
.. csv-table:: Title
:header: "A", "B"
1, 2
3, 4 | CSV 테이블 지시문 |
.. csv-table::
:file: data.csv | 파일에서 CSV |
.. list-table::
:header-rows: 1
* - A
- B
* - 1
- 2 | 리스트 테이블 |
.. automodule:: module
:members: | 모듈 자동 문서화 |
.. autoclass:: Class
:members: | 클래스 자동 문서화 |
.. autofunction:: function | 함수 자동 문서화 |
.. versionadded:: 1.0 | 추가된 버전 |
.. versionchanged:: 2.0 | 변경된 버전 |
.. deprecated:: 3.0 | 더 이상 사용 안 함 |
:math:`E = mc^2` | 인라인 수식 |
:abbr:`HTML (HyperText Markup Language)` | 약어 |
:guilabel:`OK` | GUI 라벨 |
:menuselection:`File --> Save` | 메뉴 선택 |
:kbd:`Ctrl+C` | 키보드 입력 |
:command:`ls` | OS 명령어 |
:file:`path/to/file` | 파일 경로 |