reStructuredText #

reStructuredText는 마크업 언어의 한 종류로 파씽시스템도 포함한다. reST의 문법은 그 자체로도 내용파악과 사용하기가 쉽다는 장점을 가진다. 특히 파이썬과 같은 인라인(in-liine) 프로그램의 문서화에 유용하며 실제로 파이썬에서 제공하는 문서(https://docs.python.org/3/)가 reST를 사용하는 Sphinx를 이용하여 작성되었다. reST가 지향하는 목표는 다음과 같다. 덧붙여 reST문서의 확장자는 '.rst' 이다.

1. Readable: 마크업언어에 대한 지식이 없어도 raw-form이 읽기 쉬워야 한다.
2. Unobtrusive: 문법이 최대한 단순하고 인위적이지 않아야 한다.
3. Unambigous: 문법이 모호하지 않고 반드시 하나의 입력형태는 하나의 출력형태으로만 나타나야 한다.
4. Unsurprising: 기대하는 결과가 나오게 한다.
5. Intuitive: 기억하기 쉽고 명확한 문법이여야 한다.
6. Easy: 어떤 텍스트 에디터에서도 작성하기 쉬워야 한다.
7. Scalable: 텍스트의 길이에 영향을 받지 않아야 한다.
8. Powerful: 문서화에 필요한 충분한 문법를 제공해야 한다.
9. Language-neutral: 영어뿐만아니라 모든 언어를 지원해야 한다.
10. Extentsible: 복합적인 마크업과 커스텀 마크업 추가가 쉬워야 한다.
11. Output-format-neutral: 특정 포맷에 치우치지 않고 다양한 출력포맷을 지원해야 한다.

사용법 #

구조 #

문단구분은 아래와 같이 빈줄로 구분한다. 들여쓰기를 하면 들여쓰기된 단락이 생성된다.

# raw-form
이것은 문단 입니다. 매우 짧은
첫번째 문단 입니다.

    이것은 두번째 문단입니다. 한단계 들여쓰기 되어 있습니다.
    문단은 빈 줄로 구분됩니다.

이것은 마지막 문단입니다.

# results in
이것은 문단 입니다. 매우 짧은 첫번째 문단 입니다.

    이것은 두번째 문단입니다. 한단계 들여쓰기 되어 있습니다. 문단은 빈 줄로 구분됩니다.
이것은 마지막 문단입니다.

문자 스타일 #

문자의 스타일을 아래와 같이 지정할 수 있다.

# Italics
*이탈릭체로 나옵니다.*

# Bold
**굶은 글씨로 나옵니다.**

목록 생성 #

일반 목록 #

목록의 숫자대신 #을 사용해도 자동으로 숫자를 매겨준다.

1. 목록입니다.
2. 목록입니다.
#. 목록입니다.

사전형 목록 #

항목1
    항목1의 정의 입니다.
    항목1의 정의

항목2
    항목2의 정의 입니다.
    항목2의 정의

옵션 목록 #

-a          옵션 a 설명
-b file     옵션 b 설명
--opt_a     옵션 opt_a 설명

표 생성 #

표 생성은 다음과 같이 일반적인 형태로 작성하거나

+------------+------------+-----------+ 
| Header 1   | Header 2   | Header 3  | 
+============+============+===========+ 
| body row 1 | column 2   | column 3  | 
+------------+------------+-----------+ 
| body row 2 | Cells may span columns.| 
+------------+------------+-----------+ 
| body row 3 | Cells may  | - Cells   | 
+------------+ span rows. | - contain | 
| body row 4 |            | - blocks. | 
+------------+------------+-----------+

또는, 다음과 같이 심플한 형태로 작성해도 된다.

=====  =====  ====== 
   Inputs     Output 
------------  ------ 
  A      B    A or B 
=====  =====  ====== 
False  False  False 
True   False  True 
False  True   True 
True   True   True 
=====  =====  ======

섹션 나누기 #

섹션헤더는 다음과 같이 존재하며 아래쪽으로 갈수록 하위 수준이다.

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

--------
Subtitle
--------

Chapter 1 Title
===============

Section 1.1 Title
-----------------

Subsection 1.1.1 Title
~~~~~~~~~~~~~~~~~~~~~~

Section 1.2 Title
-----------------

Chapter 2 Title
===============

이미지 넣기 #

.. image:: images.png
    :height: 100
    :width: 200
    :scale: 50
    :alt: 이미지 설명

Suggested Pages #

• 0.025 파이썬
• 0.013 컴파일
• 0.013 Java
• 0.013 PyPy
• 0.013 Jython
• 0.013 C#
• 0.013 객체 지향
• 0.013 C
• 0.013 Pyston
• 0.013 C++
• More suggestions...