Ano ang isang RST file?
Ang RST file ay isang teknikal na format ng dokumentasyon ng file, na pangunahing ginagamit sa komunidad ng Python programming. Ito ay isang text file na nakasulat sa reStructuredText markup language na naglalapat ng mga istilo at pag-format sa mga plain text na dokumento para sa pagbuo ng dokumentasyon. Ginagamit ng mga RST file ang mga komento at iba pang impormasyon sa Python programs code upang lumikha ng teknikal na dokumentasyon ng application. Gayunpaman, maaari ding maglaman ang mga ito ng text na maaaring i-convert sa mga simpleng webpage at eBooks. Maaaring gamitin ang mga text editor tulad ng Github Atom, GNU Emacs (cross-platform), Microsoft Notepad (Windows), Apple TextEdit (Mac) at Vim (Linux) upang buksan ang mga RST file.
RST File Format
Ang mga RST file ay naglalaman ng code na nakasulat sa reStructuredText markup language. Ito ay bahagi ng proyekto ng Docutils ng Python Doc-SIG (Documentation Special Interest Group) na nagbibigay ng isang set ng mga tool para sa Python na katulad ng Javadoc para sa Java. Ang parser para sa RST file foramt ay naka-embed sa Docutils at maaaring kumuha ng impormasyon mula sa mga programang Python para sa pag-format ng mga ito sa dokumentasyon ng programa.
reStructuredText RST Halimbawa
Kumuha tayo ng isang halimbawang teksto na nakasulat sa format ng RST file bilang sumusunod.
================
Document Heading
================
Heading
=======
Sub-heading
-----------
Paragraphs are separated
by a blank line.
When this text is input to an rST processor such as Docutils, the output is as follow.
<h1>Document Heading</h1>
<h2>Heading</h2>
<h3>Sub-heading</h3>
<p>Paragraphs are separated
by a blank line.</p>
