Python 的 RST 檔案是什麼

reStructuredText （ RST 、 ReST 或 reST ）是一種用于文本資料的檔案格式，主要用于 Python 程式設計語言社群的技術文檔。

它是Python Doc-SIG（Documentation Special Interest Group）的 Docutils 項目的一部分，旨在為 Python 建立一組類似于 Java 的 Javadoc 或 Perl 的 Plain Old Documentation（pod）的工具。Docutils 可以從 Python 程式中提取注釋和資訊，并将它們格式化為各種形式的程式文檔。

從這個意義上說，reStructuredText 是一種輕量級标記語言，其設計目的是（a）文檔處理軟體（如Docutils）可以處理它，（b）讀和寫 Python 源代碼的程式員很容易讀它。

reST 解析器的引用實作是 Python 程式設計語言中的 Docutils 文本處理架構的一個元件，但是還可以使用其他解析器。

沒有正式的 mime 類型注冊為 reStructuredText，但非官方的是text/x-rst

可以将 RST 檔案了解為 Python 使用的 Markup 檔案就可以了。

官方的使用手冊，請參考連結：

https://docutils.sourceforge.io/docs/user/rst/quickstart.html

目前還有一個線上的編輯環境，請參考

http://rst.ninjs.org/#Kml0YWxpY3Mq

上面的内。

你可以在上面的連結中對标記檔案進行編輯。

在編輯的過程中，你可能還需要對 Markup 的文法有所了解。

https://www.ossez.com/t/python-rst/177