概要
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開発に関わるなら、早めに慣れておきたいファイル形式の一つです。
副業から独立まで「稼げる」Webスキルを習得する(PR)
ここまで読んでいただきありがとうございます。 最後に宣伝をさせてください。
「副業を始めたいが、何から手をつければいいかわからない」「独学でスキルはついたが、収益化できていない」という悩みを持つ方には、マンツーマン指導のWebスクール**「メイカラ」**が適しています。
このスクールは、単に技術を教えるだけでなく、**「副業として具体的にどう稼ぐか」**という実務直結のノウハウ提供に特化している点が特徴です。
講師陣は、実際に「副業Webライターから1年で独立して月収100万円」を達成したプロや、現役で利益を出し続けているブロガーなど、確かな実績を持つプレイヤーのみで構成されています。そのため、机上の空論ではない、現場で通用する戦術を学ぶことができます。
副業に特化した強み
- 最短ルートの提示: 未経験からでも実績を出せるよう、マンツーマンで指導。
- AI活用の習得: 副業の時間対効果を最大化するための、正しいAI活用スキルも網羅。
- 案件獲得のチャンス: 運営がWebマーケティング会社であるため、実力次第で社内案件の紹介など、仕事に直結する可能性があります。
受講者の多くは、「在宅でできる仕事を探している」「副業を頑張りたい」という20代・30代・40代が中心です。
受講前には、講師による無料説明が行われます。無理な勧誘はなく、自分に合った副業スタイルやプランを相談できるため、まずは話を聞いてみることから始めてみてはいかがでしょうか。
