読み方 : リストラクチャードテキスト

reStructuredText【.rstファイル】

reStructuredTextとは?

プレーンテキストで文書構造を記述するための軽量マークアップ言語の一つ。主にPythonのドキュメント作成に用いられる仕様で、標準のファイル拡張子は「.rst」。
reStructuredTextのイメージ画像

この書式Pythonの開発者コミュニティで整備された文書処理システム「Docutils」により定義されている。記述はテキストファイルとして扱えるため、特別な編集ソフトを必要とせず、一般的なエディタで作成できる。

文書の構造はインデントや記号によって表現する。見出しは「=」や「-」などの記号を文字列の下に並べることで示す。どの記号を使うかに厳密な規定はなく、文書内での一貫性が重視される。段落は空行(行頭の改行)で区切られ、箇条書きや番号付きリストも特定の記号を行頭に置くだけで表現できる。

Pythonの公式ドキュメントツールである「Sphinx」との親和性が高く、ソフトウェア開発の現場で広く使われている。Sphinxを介することで、同一のrstファイルからHTMLPDF、EPUBなど複数の形式で文書ファイルを生成できる。プログラムコードと同じように、バージョン管理システムを用いて技術文書や仕様書の変更履歴を管理するのにも向いている。

同じプレーンテキスト系の軽量マークアップ言語として「Markdown」が知られているが、reStructuredTextはより厳密な仕様を持ち、脚注や引用、「ディレクティブ」(directive)と呼ばれる拡張構文など、より豊富な機能を標準で備えている。Markdownが手軽さを優先するのに対し、reStructuredTextは大規模で長期的な文書管理を想定した設計となっている。

この記事の著者 : (株)インセプト IT用語辞典 e-Words 編集部
1997年8月より「IT用語辞典 e-Words」を執筆・編集しています。累計公開記事数は1万ページ以上、累計サイト訪問者数は1億人以上です。学術論文や官公庁の資料などへも多数の記事が引用・参照されています。