Introduction to .rst file (reStructuredText):
reStructuredText is a file format for Textual data majorly used by Python based communities to develop documentation in an easy way similar to other tools like Javadoc for Java. Most of the docs of Python-based software and libraries are written using reStructuredText and hence it’s important to learn it when contributing to any organization.
Like Python, RST syntax is also sensitive to Indentation.
Example code of reStructuredText:
Some basic syntax and their HTML rendering are given below.
|verbatim||``Some text or code``||
Some text or code
Save the file with .rst extension.
Python Code :
Following is the Python code to convert .rst files to HTML files.
docutils is a predefined library downloaded while Python is installed.
publish_file method is used to convert rst to html by passing file names as parameters.
After running the python code, a HTML file would be made in the same directory as of rst file. The code of HTML is complicated than normal HTML code written by a person since it’s auto generated. The following image shows HTML rendering of reStructuredText shown above.
- Python program to reverse the content of a file and store it in another file
- File Searching using Python
- Open a File in Python
- File Handling in Python
- Python | Kivy .kv File
- Python append to a file
- How to read from a file in Python
- Writing to file in Python
- File Objects in Python
- Python | AnchorLayout in Kivy using .kv file
- Python File truncate() Method
- Python - Call function from another file
- Junk File Organizer in Python
- Check if directory contains file using python
- Create a Credential file using Python
If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to email@example.com. See your article appearing on the GeeksforGeeks main page and help other Geeks.
Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.