쓰고 싶은 내용을 텍스트로 편하게 적으면 됩니다. 다음 줄로 바꾸어 적더라도 계속 이어집니다.
1줄을 띄운 다음 내용을 적으면 새 문단에서 내용 작성이 이루어집니다.
임의의 칸 (4칸 권장)을 계속 들여쓰면 indent가 적용되어 결과가 나옵니다.
이탤릭은 * 표시 안에 텍스트를 넣습니다: 이탤릭체.
강조할 때는 ** 표시를 사용합니다: 강조 필요.
강조 (마크업) 으로도 가능합니다. 주의할 점은 를 사용한 다음 한글이 오는 경우 parsing이 잘 이루어지지 않는다는 것입니다. Sphinx 개발자를 작년에 만나 이야기를 했는데, 수정이 쉽지는 않은 것 같습니다.
항목을 나열할 때는 번호를 붙여 편하게 나열하면 됩니다.
- 첫 번째 항목
- 하위 첫 번째 항목
- 하위 두 번째 항목
- 두 번째 항목
- 알파벳으로 시작하는 첫 번째 항목
- 알파벳으로 시작하는 두 번째 항목
- "*"로 번호 없는 항목을 나열합니다.
- "-"로 서브 리스트: 번호 없는 항목을 나열합니다.
- 두 번째 번호 없는 항목 나열
코드 예제 등이 있으면 보통 아래에서 볼 수 있습니다 등 말을 사용합니다. 이 부분을 rst에서는 마지막에 :: 를 붙여 사용하고 들여쓰기를 합니다. 보기:
import requests
r = requests.get('https://api.github.com/events')다 끝났으면 들여쓰기를 없앱니다.
섹션을 쓸 때는 =, -, ~를 각각 아래에 붙여 사용합니다.
이미지를 가져올 때는 다음과 같이 사용합니다 (샘플 이미지: OpenStack 번역팀)
이미지 크기 등을 지정할 수도 있습니다.