Сравнивайте с английским: нажмите на абзац — оригинал откроется в окне. Кнопка EN под абзацем показывает его прямо в тексте.
Содержание
Введение
Легкий язык разметки
Lightweight markup language
В этом смысле reStructuredText — это лёгкий язык разметки, разработанный для обработки программным обеспечением для работы с документацией, таким как Docutils, и для удобства чтения программистами при чтении и написании исходного кода Python.
In this sense, reStructuredText is a lightweight markup language designed to be both processable by documentation processing software such as Docutils, and be easily readable by human programmers who are reading and writing Python source code.
История
reStructuredText произошел от более раннего легковесного языка разметки под названием StructuredText (разработанного Zope). В StructuredText было несколько проблем, и reST был разработан для их устранения. Название reStructuredText было выбрано, чтобы подчеркнуть, что reST является «пересмотренным, переработанным и переосмысленным StructuredText». Некоторые элементы синтаксиса reST были вдохновлены языком Setext начала 1990-х годов. При разработке также рассматривалась возможность включения элементов общепринятых форматов RFC822 для интернет-сообщений и форматов Javadoc. reStructuredText был впервые выпущен в июне 2001 года. Его активное использование в сообществе Python началось в 2002 году.
reStructuredText evolved from an earlier lightweight markup language called StructuredText (developed by Zope). There were a number of problems with StructuredText, and reST was developed to address them. The name reStructuredText was chosen to indicate that reST is a "revised, reworked, and reinterpreted StructuredText." Parts of the reST syntax were inspired by the Setext language from the early 1990s. Elements of the common RFC822 Internet Message Format and Javadoc formats were also considered for inclusion in the design. reStructuredText was first released in June 2001. It began to see significant use in the Python community in 2002.
Референтная реализация
Референтная реализация парсера reST является компонентом фреймворка обработки текста Docutils, написанного на языке программирования Python, но существуют и другие парсеры. Официальный тип MIME для reStructuredText не зарегистрирован, однако используется неофициальный тип text/x-rst.
The reference implementation of the reST parser is a component of the Docutils text processing framework in the Python programming language, but other parsers are available. There is no official MIME type registered for reStructuredText, but the unofficial one is text/x rst.
Приложения
reStructuredText обычно используется для технической документации, например, в документации к библиотекам Python. Однако он подходит для широкого спектра текстов. С 2008 года reST является основным компонентом системы генерации документации Sphinx для Python. Trac, GitHub и Bitbucket также поддерживают reStructuredText. В 2011 году Distributed Proofreaders, готовившая тексты для проекта «Гутенберг», рассматривала возможность использования reST в качестве базового формата, из которого можно было бы генерировать другие форматы электронных книг. В июле 2016 года проект ядра Linux принял решение перейти от документации на основе DocBook к reStructuredText и инструментарию Sphinx. Инструмент для сборки программного обеспечения CMake перешел с собственного языка разметки на reStructuredText в версии 3.0 для своей документации.
reStructuredText is commonly used for technical documentation, for example, in documentation of Python libraries. However, it is suitable for a wide range of texts. Since 2008, reST has been a core component of Python's Sphinx document generation system. Trac also supports reStructuredText, as do GitHub and Bitbucket. In 2011, Distributed Proofreaders, which prepared texts for Project Gutenberg, was considering adoption of reST as a basic format from which other ebook formats could be generated. In July 2016 the Linux kernel project decided to transition from DocBook based documentation to reStructuredText and the Sphinx toolchain. The software build tool CMake switched from a custom markup language to reStructuredText in version 3.0 for its documentation.