Arquivo RST

.rst é um formato de marcação leve de texto simples usado principalmente para documentação técnica no ecossistema Python. Os arquivos usam uma sintaxe legível por humanos: os títulos das seções são criados sublinhando o texto do título com caracteres como =, - ou ~; amostras de código são introduzidas com diretivas .. code-block::; as referências cruzadas usam a sintaxe :role:; e os sumários dos documentos são construídos com diretivas .. toctree::.

Em comparação com o Markdown, o .rst fornece um sistema formal de diretivas e funções que permite uma marcação semântica mais rica - notas de rodapé, citações, advertências personalizadas, referências cruzadas de API - sem exigir extensões separadas. O gerador de documentação Sphinx usa .rst como seu formato de origem nativo e produz a documentação oficial do Python, NumPy, Django e do kernel do Linux a partir de arquivos de origem .rst.

Os arquivos são texto simples UTF-8 sem estrutura binária ou magic bytes, editáveis em qualquer editor de texto. O processador padrão é o Docutils, que converte .rst para HTML, LaTeX, PDF e outras saídas por meio de ferramentas de linha de comando como rst2html e rst2latex. Grandes projetos Sphinx vinculam centenas de arquivos de origem .rst individuais por meio de diretivas .. toctree::.

O tipo MIME em uso comum é text/x-rst; o único tipo registrado na IANA, text/prs.fallenstein.rst, não é reconhecido pelo próprio projeto Docutils. O reStructuredText é mantido ativamente, embora projetos mais recentes adotem cada vez mais alternativas baseadas em Markdown, como o MyST, para fluxos de trabalho de documentação mais leves.