| Restrukturalizovaný text | |
|---|---|
| Rozšíření | .rst |
| MIME typ | text/x-rst [1] |
| Typ formátu | textové formáty |
| webová stránka | docutils.sourceforge.io/… ( anglicky) |
reStructuredText (zkratka: ReST , přípona souboru: .rst ) je lehký značkovací jazyk . Funguje dobře pro vytváření jednoduchých webových stránek a dalších dokumentů a také jako pomocný jazyk při psaní komentářů v kódu programu. Používá se systémem technické dokumentace Docutils [2] , jehož autorem je především David Goodger. reStructuredText lze považovat za potomka odlehčených značkovacích systémů StructuredText a Setext. Analyzátor reStructuredText podporuje velké množství výstupních formátů, včetně PDF , HTML , ODT , LaTeX a prezentačního formátu S5 .
Dokumentační systém Sphinx [3] , napsaný pro potřeby dokumentace programovacího jazyka Python na webu docs.python.org a postavený na bázi Docutils, je již používán v několika desítkách projektů [4] . ReST je jedním ze značkovacích jazyků používaných na githubu [5] , konkrétně pro soubory README . Formát je experimentální v projektu Gutenberg [6] [7] .
Jim Fulton, tvůrce Zope , přišel se značkovacím jazykem StructuredText , který připomíná zjednodušené označení WikiWikiWeb . Problémy StructuredText vedly k vytvoření značkovacího jazyka nazvaného ReStructuredText Davidem Goodgerem. Při tvorbě byly sledovány následující cíle [8] :
V důsledku toho se v roce 2002 objevil PEP 287 ( návrh na vylepšení Pythonu ) s popisem ReStructuredText.
Označení docstringu (v trojitých uvozovkách) v kódu Pythonu [1] :
strážce třídy ( Skladník ): """ Udržujte data déle aktuálnější. Rozšiřte `Skladovač`. Atribut třídy „instance“ sleduje počet vytvořených objektů „Keeper“. """ instance = 0 """Kolik objektů `Keeper` existuje?""" def __init__ ( self ): """ Rozšiřte `Storer.__init__()` pro sledování instancí. Udržujte počet v `self.instance` a data v `self.data`. """ Storer . __init__ ( self ) self . případy += 1 sebe . data = [] """Uložit data do seznamu, poslední poslední.""" ...