reStructuredText
| ReStructuredText | |
|---|---|
 | |
| Расширение |
..rst |
| MIME-тип | text/x-rst[1] |
| Тип формата | текстовые форматы |
| Сайт | docutils.sourceforge.io/… (англ.) |
reStructuredText (сокращение: ReST, расширение файла: .rst) — облегчённый язык разметки. Хорошо применим для создания простых веб-страниц и других документов, а также в качестве вспомогательного языка при написании комментариев в программном коде. Используется в системе подготовки технической документации Docutils[2], написанной в основном Дэвидом Гуджером (David Goodger)[3]. reStructuredText можно считать потомком легковесных систем разметки StructuredText и Setext. Парсер reStructuredText поддерживает достаточное количество конечных форматов, в том числе PDF, HTML, ODT, LaTeX и формат презентаций S5.
Система документирования Sphinx[4], написанная для нужд документирования языка программирования Python на сайте docs.python.org и построенная на базе Docutils, применяется уже в нескольких десятках проектов[5]. ReST является одним из языков разметки, используемых на github[6], в частности, для README-файлов. Формат имеет статус экспериментального в проекте «Гутенберг»[7][8].
Пример синтаксиса
================== Название документа ================== Заголовок --------- Какой-нибудь простой текст, *текст курсивом*, **текст жирным шрифтом** и ссылка_: * элемент маркированного списка * элемент маркированного списка 1. 1-й элемент нумерованного списка 2. 2-й элемент нумерованного списка .. figure:: /media/wikipedia/commons/f/f6/Wikipedia-logo-v2-ru.png Логотип русской Википедии .. _ссылка: http://ru.wikipedia.org
Разметка строк документации (внутри утроенных кавычек) в коде на Python[1]:
class Keeper(Storer):
"""
Keep data fresher longer.
Extend `Storer`. Class attribute `instances` keeps track
of the number of `Keeper` objects instantiated.
"""
instances = 0
"""How many `Keeper` objects are there?"""
def __init__(self):
"""
Extend `Storer.__init__()` to keep track of
instances. Keep count in `self.instances` and data
in `self.data`.
"""
Storer.__init__(self)
self.instances += 1
self.data = []
"""Store data in a list, most recent last."""
...
Поддержка текстовыми редакторами
Универсальные текстовые редакторы:
- Emacs (с помощью специального пакета rst-mode[9]),
- Vim (в базовой версии доступна подсветка синтаксиса),
- JED (доступен специальный режим[10]),
- ReText (специализированный редактор для языков разметки Markdown и ReST)[11],
- NoTex (редактор, работающий в браузере)[12],
- Geany
- Sublime Text 2 / Sublime Text 3.
Примечания
- ↑ 1 2 PEP 287 — reStructuredText Docstring Format
- ↑ Mertz, David. XML Matters: reStructuredText. IBM developerWorks (1 февраля 2003). Дата обращения: 28 декабря 2011. Архивировано 26 октября 2012 года.
- ↑ docutils on Ohloh
- ↑ Sphinx documentation generator
- ↑ Projects using Sphinx
- ↑ GitHub Markup
- ↑ PG Monthly Newsletter (2012-03-07)
- ↑ RST
- ↑ Emacs Support for reStructuredText (англ.)
- ↑ Mode for reStructuredText (англ.)
- ↑ Dmitri Popov, ReText: A Text Editor with Support for reStructuredText and Markdown
- ↑ NoTex