stringtranslate.com

реструктурированныйтекст

reStructuredText ( RST , ReST или reST ) — это формат файла для текстовых данных, используемый в основном в сообществе языков программирования Python для технической документации .

Это часть проекта Docutils группы Python Doc-SIG (Documentation Special Interest Group), направленного на создание набора инструментов для Python, аналогичного Javadoc для Java или Plain Old Documentation (POD) для Perl . Docutils может извлекать комментарии и информацию из программ Python и форматировать их в различные формы программной документации. [2]

В этом смысле reStructuredText — это легкий язык разметки , предназначенный для обработки с помощью программного обеспечения для обработки документации, такого как Docutils, и для легкого чтения людьми-программистами, которые читают и пишут исходный код Python .

История

reStructuredText произошел от более раннего облегченного языка разметки под названием StructuredText [3] (разработанного Zope ). У StructuredText был ряд проблем, и для их решения был разработан reST. [4] Название reStructuredText было выбрано, чтобы указать, что reST представляет собой «пересмотренный, переработанный и переосмысленный StructuredText». [5]

Части синтаксиса reST были вдохновлены языком Setext начала 1990-х годов. Элементы общего формата интернет-сообщений RFC822 и форматов Javadoc также рассматривались для включения в проект. [6]

reStructuredText был впервые выпущен в июне 2001 года. [1] Он начал широко использоваться в сообществе Python в 2002 году. [7]

Эталонная реализация

Эталонная реализация парсера reST является компонентом платформы обработки текста Docutils на языке программирования Python , но доступны и другие парсеры.

Для reStructuredText не зарегистрировано официального типа MIME , но неофициальным является text/x-rst. [8]

Приложения

reStructuredText обычно используется для технической документации, например, в документации библиотек Python. [9] Однако он подходит для широкого круга текстов.

С 2008 года reST является основным компонентом системы генерации документов Python Sphinx .

Trac также поддерживает reStructuredText [10] , как и GitHub и Bitbucket .

В 2011 году компания Distributed Proofreaders , готовившая тексты для Project Gutenberg , рассматривала возможность принятия reST в качестве базового формата, на основе которого можно было бы генерировать другие форматы электронных книг. [11] [ нужно обновить ]

В июле 2016 года проект ядра Linux решил перейти от документации на основе DocBook к reStructuredText и набору инструментов Sphinx . [12]

Инструмент сборки программного обеспечения CMake перешел с собственного языка разметки на reStructuredText в версии 3.0 для документации. [13]

Примеры

Смотрите также

Рекомендации

  1. ^ ab «Проект: reStructuredText — Список файлов». СоурсФордж . Архивировано из оригинала 19 октября 2001 года . Проверено 5 февраля 2023 г.
  2. ^ Мерц, Дэвид (1 февраля 2003 г.). «XML имеет значение: reStructuredText». IBM DeveloperWorks . Проверено 5 октября 2016 г.
  3. ^ "Документация zope.structuredtext" . Прочтите Документы . Проверено 16 августа 2022 г.
  4. ^ Гуджер, Дэвид (24 мая 2016 г.). «Проблемы со структурированным текстом». Проект Документилс . Проверено 16 августа 2022 г.
  5. ^ Гуджер, Дэвид (26 февраля 2016 г.). «Часто задаваемые вопросы по Docutils (часто задаваемые вопросы)» . Проект Документилс . Проверено 5 октября 2016 г.
  6. ^ Гуджер, Дэвид (2 апреля 2022 г.). «Запись альтернатив синтаксиса reStructuredText». docutils.sourceforge.io . Проект Документилс . Проверено 16 августа 2022 г.
  7. ^ «Введение в reStructuredText». Напишите документы . Проверено 25 июня 2022 г.
  8. ^ «Какой официальный тип MIME для данных reStructuredText? В FAQ по Docutils» . Проект Документилс . Проверено 20 декабря 2017 г.
  9. ^ Гуджер, Дэвид (2 апреля 2002 г.). «PEP 287 — формат строки документации reStructuredText». Фонд программного обеспечения Python . Проверено 5 октября 2016 г.
  10. ^ «Поддержка reStructuredText в Trac» . Трек . 13 сентября 2016 г. Проверено 5 октября 2016 г.
  11. ^ Ньюби, Грег (08 января 2011 г.). «Протокол заседания от 11 декабря 2010 года» . Распределенные корректоры . Проверено 8 января 2011 г.
  12. ^ «Документация ядра Sphinx, часть 1: как мы сюда попали» . LWN.net. 06.07.2016 . Проверено 27 октября 2016 г.
  13. ^ «Примечания к выпуску CMake 3.0.0» . Kitware, Inc. 10 июня 2014 г. Проверено 5 октября 2016 г.

Внешние ссылки