Archivo RST

.rst es un formato de marcado ligero de texto plano utilizado principalmente para documentación técnica en el ecosistema Python. Los archivos utilizan una sintaxis legible por humanos: los encabezados de sección se crean subrayando el texto del título con caracteres como =, - o ~; las muestras de código se introducen con directivas .. code-block::; las referencias cruzadas utilizan la sintaxis :role:; y las tablas de contenido del documento se construyen con directivas .. toctree::.

En comparación con Markdown, .rst proporciona un sistema formal de directivas y roles que permite un marcado semántico más rico -notas al pie, citas, advertencias personalizadas, referencias cruzadas de API- sin necesidad de extensiones separadas. El generador de documentación Sphinx utiliza .rst como su formato de origen nativo y produce la documentación oficial de Python, NumPy, Django y el kernel de Linux a partir de archivos fuente .rst.

Los archivos son texto plano UTF-8 sin estructura binaria ni magic bytes, editables en cualquier editor de texto. El procesador estándar es Docutils, que convierte .rst a HTML, LaTeX, PDF y otros formatos a través de herramientas de línea de comandos como rst2html y rst2latex. Los proyectos grandes de Sphinx enlazan cientos de archivos fuente .rst individuales a través de directivas .. toctree::.

El tipo MIME de uso común es text/x-rst; el único tipo registrado en IANA, text/prs.fallenstein.rst, no es reconocido por el propio proyecto Docutils. reStructuredText se mantiene activamente, aunque los proyectos más nuevos adoptan cada vez más alternativas basadas en Markdown como MyST para flujos de trabajo de documentación más ligeros.