| Átstrukturált szöveg | |
|---|---|
| Kiterjesztés | .rst |
| MIME típusú | text/x-rst [1] |
| Formátum típusa | szöveges formátumok |
| Weboldal | docutils.sourceforge.io/… ( angol) |
A reStructuredText (rövidítése: ReST , fájlkiterjesztés: .rst ) egy könnyű jelölőnyelv . Jól működik egyszerű weblapok és egyéb dokumentumok létrehozásához, valamint segédnyelvként programkódban történő megjegyzések írásakor. A Docutils [2] műszaki dokumentációs rendszere használja , elsősorban David Goodger írta. A reStructuredText a könnyű StructuredText és Setext jelölőrendszerek leszármazottjaként fogható fel. A reStructuredText elemző számos kimeneti formátumot támogat, beleértve a PDF , HTML , ODT , LaTeX és az S5 prezentációs formátumot .
A docs.python.org oldalon a Python programozási nyelv dokumentálására írt és a Docutils alapján felépülő Sphinx dokumentációs rendszert [3] már több tucat projektben használják [4] . A ReST a github [5] egyik jelölőnyelve , kifejezetten a README fájlokhoz . A formátum kísérleti jellegű a Project Gutenbergben [6] [7] .
Jim Fulton, a Zope megalkotója egy olyan StructuredText jelölőnyelvvel rukkolt elő , amely egy egyszerűsített WikiWikiWeb jelölőre hasonlít . A StructuredText problémái oda vezettek, hogy David Goodger megalkotta a ReStructuredText nevű jelölőnyelvet. Létrehozásakor a következő célokat követték [8] :
Ennek eredményeként 2002-ben megjelent a PEP 287 ( Python javítási javaslat ) a ReStructuredText leírásával.
Docsstring jelölés (három idézőjelben) Python kódban [1] :
osztályőrző ( tároló ) : """ Tartsa hosszabb ideig frissen az adatokat. Bővítse ki a "Storer" elemet. Az „instances” osztályattribútum nyomon követi a példányosított „Keeper” objektumok számát. """ instances = 0 """Hány `Keeper` objektum van?""" def __init__ ( self ): """ A `Storer.__init__()` kiterjesztése az esetek nyomon követéséhez. Tartsa a számlálást a `self.instances` és az adatokat a `self.data`-ban. """ Tároló . __init__ ( én ) én . példányok += 1 önmaga . data = [] """Adatok tárolása listában, a legutóbbi utolsó.""" ...