| Texto reestructurado | |
|---|---|
| Extensión | .rst |
| tipo MIME | texto/x-primero [1] |
| Tipo de formato | formatos de texto |
| Sitio web | docutils.sourceforge.io/… ( inglés) |
reStructuredText (abreviatura: ReST , extensión de archivo: .rst ) es un lenguaje de marcado ligero . Funciona bien para crear páginas web simples y otros documentos, y también como lenguaje auxiliar al escribir comentarios en el código del programa. Utilizado por el sistema de documentación técnica Docutils [2] , escrito principalmente por David Goodger. Se puede pensar en reStructuredText como un descendiente de los sistemas de marcado ligeros StructuredText y Setext. El analizador reStructuredText admite una buena cantidad de formatos de salida, incluidos PDF , HTML , ODT , LaTeX y el formato de presentación S5 .
El sistema de documentación Sphinx [3] , escrito para las necesidades de documentación del lenguaje de programación Python en el sitio docs.python.org y construido sobre la base de Docutils, ya se utiliza en varias docenas de proyectos [4] . ReST es uno de los lenguajes de marcado utilizados en github [5] , específicamente para archivos README . El formato es experimental en Project Gutenberg [6] [7] .
Jim Fulton, el creador de Zope , ideó un lenguaje de marcado de texto estructurado que se asemeja a un marcado WikiWikiWeb simplificado . Los problemas de StructuredText llevaron a David Goodger a crear un lenguaje de marcado llamado ReStructuredText. Al crear, se persiguieron los siguientes objetivos [8] :
Como resultado, PEP 287 ( propuesta de mejora de Python ) apareció en 2002 con una descripción de ReStructuredText.
Marcado docstring (entre comillas triples) en código Python [1] :
guardián de la clase ( almacenador ): """ Mantenga los datos actualizados durante más tiempo. Extiende `Storer`. El atributo de clase `instances` realiza un seguimiento del número de objetos `Keeper` instanciados. """ instancias = 0 """¿Cuántos objetos `Guardián` hay?""" def __init__ ( self ): """ Extienda `Storer.__init__()` para realizar un seguimiento de las instancias. Mantenga la cuenta en `self.instances` y los datos en `self.data`. """ Storer . __init__ ( auto ) auto . instancias += 1 uno mismo data = [] """Almacenar datos en una lista, los más recientes al final.""" ...