reEstructuradoTexto

reStructuredText ( RST , ReST o reST ) es un lenguaje de marcado de texto plano que se utiliza principalmente para documentación técnica y otros datos textuales. Cumple una función similar a la de Markdown , pero incluye características semánticas adicionales para una estructuración de documentos más compleja. Entre los proyectos de código abierto más destacados y a gran escala que utilizan reStructuredText se encuentran la comunidad del lenguaje de programación Python para su documentación oficial, la documentación del kernel de Linux , CMake y el proyecto del compilador LLVM .

Forma parte del proyecto Docutils del Python Doc-SIG (Grupo de Interés Especial en Documentación), cuyo objetivo es crear un conjunto de herramientas para Python similares a Javadoc para Java o Plain Old Documentation (POD) para Perl . Docutils puede extraer comentarios e información de programas Python y formatearlos en diversas formas de documentación de programas. ^{[ 2 ]}

En este sentido, reStructuredText es un lenguaje de marcado ligero diseñado para ser procesado por software de procesamiento de documentación como Docutils, y a la vez ser fácilmente legible por programadores humanos que leen y escriben código fuente de Python .

reStructuredText evolucionó a partir de un lenguaje de marcado ligero anterior llamado StructuredText ^{[ 3 ]} (desarrollado por Zope ). StructuredText presentaba varios problemas, y reST se desarrolló para solucionarlos. ^{[ 4 ]} El nombre reStructuredText se eligió para indicar que reST es un "StructuredText revisado, reelaborado y reinterpretado". ^{[ 5 ]}

Partes de la sintaxis de reST se inspiraron en el lenguaje Setext de principios de la década de 1990. También se consideraron elementos de los formatos comunes RFC822 (Formato de Mensajes de Internet) y Javadoc para su inclusión en el diseño. ^{[ 6 ]}

reStructuredText se lanzó por primera vez en junio de 2001. ^{[ 1 ]} Comenzó a tener un uso significativo en la comunidad de Python en 2002. ^{[ 7 ]}

La implementación de referencia del analizador reST es un componente del marco de procesamiento de texto Docutils en el lenguaje de programación Python , pero existen otros analizadores disponibles.

El proyecto Docutils no ha registrado ningún tipo MIME para reStructuredText ni ha designado ningún tipo MIME no registrado como oficial, pero documenta el tipo MIME text/x-rstcomo de facto en uso por, por ejemplo, el sistema de compilación del sitio web de Python. ^{[ 8 ]} El mismo tipo MIME se utiliza en la base de datos de tipos de archivo freedesktop.org utilizada por los entornos de escritorio en Linux . ^{[ 9 ]} Otro tipo MIME, text/prs.fallenstein.rst, fue registrado como un tipo MIME vanidoso por un tercero en 2003 para representar reStructuredText, y sigue siendo el único tipo MIME registrado por IANA para reStructuredText, ^{[ 10 ]} aunque el proyecto Docutils no lo reconoce como tal. ^{[ 8 ]}

reStructuredText se usa comúnmente para documentación técnica, por ejemplo, en la documentación de bibliotecas de Python. ^{[ 11 ]} Sin embargo, es adecuado para una amplia gama de textos.

Desde 2008, reST ha sido un componente fundamental del sistema de generación de documentos Sphinx de Python .

Trac también admite reStructuredText, ^{[ 12 ]} al igual que GitHub y Bitbucket .

En 2011, Distributed Proofreaders , que preparaba textos para el Proyecto Gutenberg , estaba considerando la adopción de reST como un formato básico a partir del cual se podrían generar otros formatos de libros electrónicos. ^{[ 13 ]}

En julio de 2016, el proyecto del kernel de Linux decidió pasar de la documentación basada en DocBook a reStructuredText y la cadena de herramientas Sphinx . ^{[ 14 ] [ 15 ]}

La herramienta de compilación de software CMake cambió de un lenguaje de marcado personalizado a reStructuredText en la versión 3.0 para su documentación. ^{[ 16 ]}

El ecosistema IDE de JetBrains admite la edición de reStructuredText a través de complementos como reStructuredText Pro , que proporciona soporte para la documentación RST y Sphinx, incluyendo vista previa en vivo y resaltado de sintaxis. ^{[ 17 ]}

• Comparación de lenguajes de marcado de documentos
• Comparación de generadores de documentación
• Comparación de software para tomar notas

• Sitio web oficial de reStructuredText con páginas de referencia.