ReStructuredText

reStructuredText
reStructuredText logo
Расширение .rst
MIME-тип
  • text/x-rst
  • text/prs.fallenstein.rst
Разработчик Дэвид Гуджер
Опубликован 1 июня 2001; 25 лет назад (2001-06-01)[1]
Последний выпуск Revision 8407 (29 октября 2019; 6 лет назад (2019-10-29))
Тип формата облегчённый язык разметки[вд] и формат файла
Открытый формат? да
Сайт docutils.sourceforge.io/rst.html

reStructuredText (сокращение: ReST, расширение файла: .rst) — облегчённый язык разметки. Хорошо применим для создания простых веб-страниц и других документов, а также в качестве вспомогательного языка при написании комментариев в программном коде. Используется в системе подготовки технической документации Docutils[2], написанной в основном Дэвидом Гуджером (David Goodger). reStructuredText можно считать потомком легковесных систем разметки StructuredText и Setext. Парсер reStructuredText поддерживает достаточное количество конечных форматов, в том числе PDF, HTML, ODT, LaTeX и формат презентаций S5.

Система документирования Sphinx[3], написанная для нужд документирования языка программирования Python на сайте docs.python.org и построенная на базе Docutils, применяется уже в нескольких десятках проектов[4]. ReST является одним из языков разметки, используемых на github[5], в частности, для README-файлов. Формат имеет статус экспериментального в проекте «Гутенберг»[6][7].

История

Джим Фултон, создатель Zope, придумал язык разметки StructuredText, напоминающий упрощённую разметку WikiWikiWeb. Проблемы StructuredText привели к созданию Дэвидом Гуджером языка разметки, названного ReStructuredText. При создании преследовались следующие цели[8]:

  • Удобочитаемость
  • Ненавязчивость
  • Однозначность
  • Отсутствие сюрпризов
  • Интуитивность
  • Простота
  • Масштабируемость
  • Выразительная мощность
  • Языковая нейтральность
  • Расширяемость
  • Независимость от выходного формата

В результате в 2002 году появился PEP 287 (англ. Python enhancement proposal — предложение по развитию Python) с описанием ReStructuredText.

Пример синтаксиса

 ==================
 Название документа
 ==================
 
 Заголовок
 ---------
 
 Какой-нибудь простой текст, *текст курсивом*, **текст жирным шрифтом** и ссылка_:
 
 * элемент маркированного списка
 * элемент маркированного списка
 
 1. Первый элемент нумерованного списка
 2. Второй элемент нумерованного списка

 .. figure:: http://upload.wikimedia.org/wikipedia/commons/f/f6/Wikipedia-logo-v2-ru.png
 
     Логотип русской Википедии 
 
 .. _ссылка: http://ru.wikipedia.org

Разметка строк документации (внутри утроенных кавычек) в коде на Python[9]: 

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."""
...

См. также

Примечания

  1. ↑ Project: reStructuredText - File List. SourceForge. Дата обращения: 5 февраля 2023. Архивировано 19 октября 2001 года.
  2. ↑ Mertz, David. XML Matters: reStructuredText. IBM developerWorks (1 февраля 2003). Дата обращения: 28 декабря 2011. Архивировано из оригинала 26 октября 2012 года.
  3. ↑ Sphinx documentation generator. Дата обращения: 29 сентября 2012. Архивировано из оригинала 20 мая 2012 года.
  4. ↑ Projects using Sphinx. Дата обращения: 29 сентября 2012. Архивировано из оригинала 15 сентября 2012 года.
  5. ↑ GitHub Markup. Дата обращения: 29 сентября 2012. Архивировано 20 июля 2012 года.
  6. ↑ PG Monthly Newsletter (2012-03-07). Дата обращения: 29 сентября 2012. Архивировано 5 сентября 2014 года.
  7. ↑ RST. Дата обращения: 29 сентября 2012. Архивировано 9 июня 2012 года.
  8. ↑ Thomas Bitterman. Mastering IPython 4.0. — Packt Publishing, 2016.
  9. ↑ Goodger, David. PEP 287 -- reStructuredText Docstring Format. Python Software Foundation (2 апреля 2002). Дата обращения: 5 октября 2016.

Ссылки

Content Disclaimer

Informasi ini disarikan dari Wikipedia dan disajikan kembali untuk tujuan edukasi. Konten tersedia di bawah lisensi CC BY-SA 3.0. Kami tidak bertanggung jawab atas ketidakakuratan data yang bersumber dari kontribusi publik tersebut.

  1. The information displayed on this website is sourced in part or in whole from Wikipedia and has been adapted for the purpose of restating it. We strive to provide accurate and relevant information, however:
  2. There is no guarantee of absolute accuracy. Wikipedia is an open, collaborative project that can be edited by anyone, so information is subject to change.
  3. It is not intended to constitute professional advice. The content displayed is for informational and educational purposes only. For important decisions (e.g., medical, legal, or financial), please consult a professional.
  4. Content copyright. Wikipedia is licensed under the Creative Commons Attribution-ShareAlike License (CC BY-SA). This means that content may be reused with appropriate attribution and shared under a similar license.
  5. Responsible use. Any risk arising from the use of information from this website is entirely the responsibility of the user.