reStructuredText – жеңіл таңбалау тілі, Python кодтарын оқу/жазуға және Docutils сияқты құжат өңдеуге арналған. StructuredText-тің жетілдірілген нұсқасы.
Ағылшыншамен салыстырыңыз: абзацты басыңыз — түпнұсқа терезеде ашылады. Абзац астындағы 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, Zope әзірлеген StructuredText деп аталатын бұрынғы жеңіл таңбалау тілінен пайда болды. StructuredText-те бірнеше мәселелер болды және оларды шешу үшін reST әзірленді. reStructuredText атауы reST-нің «өзгертілген, қайта өңделген және жаңаша түсіндірілген StructuredText» екенін көрсету мақсатымен таңдалды. reST синтаксисінің кейбір бөліктері 1990-шы жылдардың басындағы Setext тілінен шабыт алды. Сонымен қатар, кең таралған RFC822 Интернет хабарлама форматы мен Javadoc форматтарының элементтерін де жобаға қосу қарастырылды. reStructuredText алғаш рет 2001 жылдың маусым айында жарияланды. Ол 2002 жылы Python қауымдастығында кеңінен қолданыла бастады.
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 талдаушысының эталондық нұсқасы Python бағдарламалау тіліндегі Docutils мәтінді өңдеу аясының бір бөлігі болып табылады, бірақ басқа талдаушылар да қол жетімді. reStructuredText үшін ресми MIME түрі тіркелмеген, бірақ бейресми түрі 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 Python-ның Sphinx құжатты жасау жүйесінің маңызды бөлігі болып табылады. Trac, сондай-ақ GitHub және Bitbucket та reStructuredText-ті қолдайды. 2011 жылы Project Gutenberg үшін мәтіндерді дайындаған Distributed Proofreaders reST-ді басқа электрондық кітап форматтарын жасауға болатын негізгі формат ретінде қабылдауды қарастырды. 2016 жылдың шілдесінде Linux ядролық жобасы DocBook негізіндегі құжаттамадан reStructuredText және Sphinx құралдар жинағына көшуге шешім қабылдады. CMake бағдарламалық құрал өзінің құжаттамасы үшін 3.0 нұсқасында арнайы белгілеу тілінен reStructuredText-ке ауысты.
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.