| Omstruktureret tekst | |
|---|---|
| Udvidelse | .rst |
| MIME -type | tekst/x-rst [1] |
| Formattype | tekstformater |
| Internet side | docutils.sourceforge.io/… ( engelsk) |
reStructuredText (forkortelse: ReST , filtypenavn: .rst ) er et letvægts opmærkningssprog . Det fungerer godt til at lave simple websider og andre dokumenter, og også som et hjælpesprog, når du skriver kommentarer i programkode. Brugt af Docutils [2] tekniske dokumentationssystem , primært skrevet af David Goodger. reStructuredText kan opfattes som en efterkommer af de lette StructuredText og Setext markup-systemer. ReStructuredText-parseren understøtter et rimeligt antal outputformater, inklusive PDF , HTML , ODT , LaTeX og S5 -præsentationsformatet .
Sphinx - dokumentationssystemet [3] , skrevet til behovet for at dokumentere Python - programmeringssproget på webstedet docs.python.org og bygget på basis af Docutils, bruges allerede i flere dusin projekter [4] . ReST er et af de markup-sprog, der bruges på github [5] , specifikt til README-filer . Formatet er eksperimentelt i Project Gutenberg [6] [7] .
Jim Fulton, skaberen af Zope , kom med et StructuredText markup sprog , der ligner en forenklet WikiWikiWeb markup . StructuredTexts problemer førte til David Goodgers oprettelse af et markup-sprog kaldet ReStructuredText. Ved oprettelsen blev følgende mål forfulgt [8] :
Som et resultat dukkede PEP 287 ( Python-forbedringsforslag ) op i 2002 med en beskrivelse af ReStructuredText.
Docstring-markering (inden for tredobbelte anførselstegn) i Python -kode [1] :
klasse Keeper ( lager ): """ Hold data friskere længere. Udvid `Storer`. Klasseattributten "instanser" holder styr på antallet af "Keeper"-objekter, der instansieres. """ instanser = 0 """Hvor mange `Keeper`-objekter er der?""" def __init__ ( self ): """ Udvid `Storer.__init__()` for at holde styr på forekomster. Hold optælling i `self.instances` og data i `self.data`. """ Lager . __init__ ( selv ) selv . forekomster += 1 selv . data = [] """Gem data på en liste, seneste sidst.""" ...