概要
Raspberry Pi（ラズパイ）でプログラムを組んでいたところ、パッケージ内に「.rst」という見慣れない拡張子のファイルがありました。
今回は、この「.rst」ファイルが何か、どのように使われているのかを調べてまとめました。
.rstとは？｜reStructuredTextの拡張子
.rstファイルとは、「reStructuredText（リストラクチャードテキスト）」と呼ばれる軽量マークアップ言語の形式です。
主にPythonプロジェクトのドキュメント作成に使われており、Sphinx（スフィンクス）というドキュメント生成ツールと組み合わせることで、HTMLやPDFなどの形式に変換してドキュメントを公開できます。
.rstファイルの特徴
可読性が高い
reStructuredTextは、マークアップが少なく、見たまま読みやすいのが特徴です。
プログラム開発者以外の読者にも優しい構文設計になっています。
出力形式が豊富
Sphinxを使うことで、以下のような形式に簡単に変換できます。
- HTML（Webサイト用）
- PDF（印刷や配布用）
- LaTeX（学術論文などの高精度フォーマット）
カスタマイズ性が高い
拡張機能や独自ディレクティブを定義することで、柔軟に文書構造を調整できます。
たとえば、APIドキュメントやモジュール構造の解説に向いています。
reStructuredTextの使用例
.rstファイルは、以下のような用途で頻繁に利用されています。
- PythonプロジェクトのREADMEファイル
- 公式ドキュメントやチュートリアル（例：Python公式ドキュメント）
- 技術的なマニュアルや操作ガイド
- Sphinxを使った自動ドキュメント生成
- 学術論文・数式入りのドキュメント
Python開発者であれば、Sphinx + .rstは定番の組み合わせです。
reStructuredTextの基本構文
以下は、.rstファイルで使われる主なマークアップ構文の一部です。
見出し
これは見出し1
============
これは見出し2
-------------
箇条書きリスト
- 項目1
- 項目2
- 項目3
番号付きリスト
1. 一つ目
2. 二つ目
3. 三つ目
強調表示
*イタリック*
**太字**
リンクの挿入
`OpenAI <https://www.openai.com>`_
構文はシンプルで覚えやすく、慣れると効率的にドキュメント作成ができます。
まとめ
.rstは reStructuredText形式の拡張子- Python開発における 公式ドキュメントやREADME作成で定番の形式
- 読みやすく、変換しやすく、多様なフォーマットに出力可能
- Sphinxと組み合わせて HTML・PDFなどに変換してWeb公開できる
Markdownに近い構文ながら、より高度な構造化や拡張機能が使えるのがreStructuredTextの魅力です。
Python開発に関わるなら、早めに慣れておきたいファイル形式の一つです。
IT・ガジェット・電子工作の知識をこれひとつで
ここまで読んでいただきありがとうございます。最後に宣伝をさせてください。
PCアプリの操作解説、最新のガジェット情報、そして電子工作の専門書まで。 Kindle Unlimitedなら、あらゆるジャンルのIT・デジタル関連書籍が読み放題です。
「仕事の効率化」から「趣味の深掘り」まで、高価な専門書をわざわざ買わずに、必要な情報をその場で引き出せるのが最大のメリット。 現在は30日間の無料体験や、対象者限定の「3ヶ月499円」プランなどが用意されています。まずはご自身のアカウントでお得なオファーが表示されるかご確認ください。
