Back

ⓘ ReStructuredText




                                     

ⓘ ReStructuredText

reStructuredText је текстуални формат датотеке првобитно коришћен у програмском језику Пајтон у сврху техничке документације.

RST је део пројекта Docutils чији је циљ био креирање сета алата за Пајтон, слично оном што Javadoc јесте за Јаву. Помоћу Docutils-а могуће је издвојити неки део кода написаног у Пајтону и затим га обликовати у разне форме програмске документације.

У том смислу, reStructuredText је једноставан језик за означавање енгл. lightweight markup language који је осмишљен да истовремено буде

а обрадив од стране софтвера за документацију попут Docutils-а и б разумљив програмерима који читају и пишу кодове у Пајтону

                                     

1. Историја

Раније је постојало доста проблема са StructuredText језиком за означавање, те је reST развијен да би их решио.

Прва значајнија примена reStructuredText-а у Пајтон заједници се могла видети 2002.године.

                                     

2. Референтна имплементација

Референтна имплементација саме reST синтаксне анализе је саставни део Docutils оквира за обраду текста у Пајтону.

Још увек не постоји званичан усвојен миме тип reStructuredText-а, али незваничан који се користи јесте text/x-rst.

                                     

3. Примена

reStructuredText се обично користи за техничку документацију, ­­на пример у документацији Пајтон библиотека, али то не мора бити једина примена јер је reST погодан за широк спектар текстова.

Од 2008. године reST представља главну компоненту Sphinx генератора документације, написаног у Пајтону. Овај формат такође подржавају GitHub и Bitbucket, као и Trac.

У 2011. години, лектори који су припремали текстове за Пројекат Гутенберг разматрали су усвајање reST-а као основног формата из којег би могли да се генеришу други формати е-књига.

Такође, CМake алат је са CMSенгл. custom markup language прешао на reStructuredText у верзији 3.0 за своју документацију.

                                     
  • је да конвертује reStructuredText фајлове у HTML вебсајтове и у друге формате као што су PDF, EPub, Texinfo и man. На reStructuredText фајлове је могуће
  • омогућава интеграцију Р кода у LaTeX, LyX, HTML, Markdown, AsciiDoc, и reStructuredText документа. Сврха кnitr је да дозволи репродуциона истраживања у преко