reStructuredText

1. 개요[편집]

---

reStructuredText 는 각종 문서꾸밈을 위한 마크업 구문 혹은 이를 파싱하는 라이브러리를 말한다. 구문은 다르지만 HTML과 비슷한 관계라 보면 된다. 이를 이용하여 작성된 문서의 확장자는 보통

.rst

이며 일반 텍스트 파일로 되어 있다. 마치 HTML이 태그를 이용해서 작성한 텍스트 문서인 것과 비슷하다.

2. 상세[편집]

---

보통 소프트웨어의 헬프 파일이나 간략 매뉴얼, 인라인 프로그램 문서(예: Python 독스트링) 등의 작성에 사용된다. reStructuredText 파서는 Docutils의 구성 요소이고 reStructuredText는 StructuredText 및 Setext 경량 마크업을 개량한 것이다.

범용적으로 사용할 수 있는 마크업 언어이긴 한데 주로 파이선에서 사용된다. 애초에 reStructuredText의 주요 목표가 Python 독스트링 및 기타 문서 도메인에서 사용하기 위한 마크업 구문을 정의하고 구현하는 것이 었다.

GitHub의 readme 파일 형식으로 지원되며 이보다 더 널리 쓰이는 마크다운(.md) 파일에 비해 훨씬 다양한 문서 꾸밈을 할 수 있다. 그 대신 .md 파일보다 문법이 좀 복잡하다.

Sphinx라는 reStructuredText기반 문서 프레임워크가 존재한다.