.RST вариант №
Файл RST — это формат файла технической документации, используемый в основном в сообществе программистов Python. Это текстовый файл, написанный на языке разметки reStructuredText, который применяет стили и форматирование к обычным текстовым документам для создания документации. Файлы RST используют комментарии и другую информацию в коде программ Python для создания технической документации приложения. Однако они также могут содержать текст, который можно преобразовать в простые веб-страницы и электронные книги. Для открытия файлов RST можно использовать текстовые редакторы, такие как Github Atom, GNU Emacs (кроссплатформенный), Microsoft Notepad (Windows), Apple TextEdit (Mac) и Vim (Linux).
Формат файла RST
Файлы RST содержат код, написанный на языке разметки reStructuredText. Это часть проекта Docutils Python Doc-SIG (Группа по интересам документации), который предоставляет набор инструментов для Python, аналогичный Javadoc для Java. Парсер для форматов файлов RST встроен в Docutils и может извлекать информацию из программ Python для их форматирования в программную документацию.
Пример reStructuredText RST
Давайте возьмем пример текста, написанного в формате файла RST, как показано ниже.
================
Document Heading
================
Heading
=======
Sub-heading
-----------
Paragraphs are separated
by a blank line.
Когда этот текст вводится в процессор rST, такой как Docutils, вывод выглядит следующим образом.
<h1>Document Heading</h1>
<h2>Heading</h2>
<h3>Sub-heading</h3>
<p>Paragraphs are separated
by a blank line.</p>
