RST ファイル形式とは？
.rst は、主に Python エコシステムのテクニカルドキュメントで使用されるプレーンテキストの軽量マークアップ形式です。ファイルは人間が読みやすい構文を使用します。セクション見出しはタイトルテキストの下に =、-、~ などの文字でアンダーラインを引くことで作成され、コードサンプルは .. code-block:: ディレクティブで導入されます。相互参照には :role: 構文が使われ、ドキュメントの目次は .. toctree:: ディレクティブで構築されます。
Markdown と比較して、.rst はより豊かな意味論的マークアップ（脚注、引用、カスタム警告、API 相互参照など）を、個別の拡張機能を必要とせずに実現する正式なディレクティブとロールシステムを提供します。ドキュメント生成ツールの Sphinx は、.rst をネイティブのソース形式として使用し、Python、NumPy、Django、および Linux カーネルの公式ドキュメントを .rst ソースファイルから生成しています。
ファイルは UTF-8 のプレーンテキストであり、バイナリ構造やマジックバイトはなく、任意のテキストエディタで編集可能です。標準的なプロセッサは Docutils で、rst2html や rst2latex などのコマンドラインツールを介して .rst を HTML、LaTeX、PDF、その他の出力に変換します。大規模な Sphinx プロジェクトでは、.. toctree:: ディレクティブを通じて数百の個別の .rst ソースファイルをリンクします。
一般的に使用される MIME タイプは text/x-rst です。唯一の IANA 登録タイプである text/prs.fallenstein.rst は、Docutils プロジェクト自体には認められていません。reStructuredText は活発にメンテナンスされていますが、新しいプロジェクトでは、より軽量なドキュメントワークフローのために MyST などの Markdown ベースの代替手段を採用することが増えています。
セキュリティと安全性
リスク： LOWRST ファイルはプレーンテキストであり、それ自体でコードを実行することはないため、開いても安全です。唯一の注意点として、Sphinx ディレクティブにはブラウザでレンダリングされる生の HTML (.. raw:: html) を含めることができます。信頼できない RST ソースからレンダリングされた出力には、アクティブな HTML/JS が含まれている可能性があります。出所が不明な場合は、生のソースを読むか、サンドボックス化されたレンダラーを使用するようにしてください。
形式の詳細
概要- IBM VoiceType Script File - レガシーな IBM VoiceType 音声認識スクリプト（1990年代の IBM 製品）。現在は事実上絶滅しています。
- Abaqus Results File - Abaqus FEA シミュレーションのバイナリ再開/結果ファイル。テキストマークアップとは無関係です（.rst 拡張子を持つバイナリ形式）。
RST ファイルを開くプログラム
Windows5 apps
Notepad
オープンソース .rst を開くことができます。Notepad++ には、RST 構文ハイライト用のコミュニティ UDL（ユーザー定義言語）があります。プレビューなしの軽量な編集に適しています。 
Visual Studio Code
無料 «reStructuredText» 拡張機能 (lextudio.restructuredtext) をインストールすると、構文ハイライトと RST プレビューペインによるライブ HTML プレビューが利用できます。 
Sphinx (sphinx-build)
オープンソース «sphinx-build -b html docs/ _build/html» を実行して、.rst ファイルを完全な HTML ドキュメントサイトにレンダリングします。pip install sphinx でインストールします。
Docutils (rst2html)
オープンソース «rst2html file.rst file.html» を実行して、単一の .rst を HTML に変換します。pip install docutils でインストールします。 
macOS3 apps
Visual Studio Code
無料 «reStructuredText» 拡張機能 (lextudio.restructuredtext) をインストールすると、構文ハイライトと RST プレビューペインによるライブ HTML プレビューが利用できます。
Sphinx (sphinx-build)
オープンソース «sphinx-build -b html docs/ _build/html» を実行して、.rst ファイルを完全な HTML ドキュメントサイトにレンダリングします。pip install sphinx でインストールします。 
Linux3 apps
Visual Studio Code
無料 «reStructuredText» 拡張機能 (lextudio.restructuredtext) をインストールすると、構文ハイライトと RST プレビューペインによるライブ HTML プレビューが利用できます。
Sphinx (sphinx-build)
オープンソース «sphinx-build -b html docs/ _build/html» を実行して、.rst ファイルを完全な HTML ドキュメントサイトにレンダリングします。pip install sphinx でインストールします。 技術的詳細
詳細仕様| エンコーディング | プレーンテキスト、UTF-8（ASCII 互換。Windows ファイルには UTF-8 BOM が含まれる場合があります） |
| セクション見出し | タイトルテキストの下（およびオプションで上）に =、-、~、^、またはその他の記号でアンダーラインを引きます |
| ディレクティブ | コードブロック、画像、注釈、目次（toctree）、およびカスタム拡張機能のための .. directive-name:: 構文 |
| インラインロール | 意味論的な相互参照、略語、および数式のための `:role:` 構文 |
| 目次 | .. toctree:: ディレクティブ (Sphinx) により、複数の .rst ファイルをナビゲート可能なドキュメントツリーにリンクします |
| 標準プロセッサ | Docutils (rst2html, rst2latex, rst2pdf, rst2xml) |
| Sphinx 拡張 | Sphinx は、コアとなる RST の上に :ref:、:doc:、autodoc、およびその他のプロジェクト固有のディレクティブを追加します |
| MIME タイプ | text/x-rst (事実上); text/prs.fallenstein.rst (IANA 登録済み、ほとんど使用されません) |
| シグネチャ / マジックバイト | なし - バイナリヘッダーのないプレーンテキストファイル |
| 主要なエコシステム | Python ドキュメント（公式 Python ドキュメント、NumPy、Django、Linux カーネルドキュメント、Read the Docs） |
| 一般的なサイズ | ソースファイルあたり 1 KB ～ 500 KB。大規模な Sphinx プロジェクトには数百の .rst ファイルが含まれる場合があります |
| リリース日 | 2002 (David Goodger, first release April 2, 2002) |
| 最新バージョン | Docutils 0.21 (2024); no separate RST format version number |
| オープンスタンダード | はい · ロイヤリティフリー |
| 仕様書 | docutils.sourceforge.io |
RST の変換
コミュニティ Q&A
ユーザーからの質問まだ質問はありません。RST ファイルについて最初の質問をしてみましょう。
