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