File RST

.rst è un formato di markup leggero in testo semplice utilizzato principalmente per la documentazione tecnica nell'ecosistema Python. I file utilizzano una sintassi leggibile dall'uomo: le intestazioni delle sezioni vengono create sottolineando il testo del titolo con caratteri come =, - o ~; gli esempi di codice sono introdotti dalle direttive .. code-block::; i riferimenti incrociati utilizzano la sintassi :role:; e i sommari dei documenti sono costruiti con le direttive .. toctree::.

Rispetto a Markdown, .rst fornisce un sistema formale di direttive e ruoli che consente un markup semantico più ricco - note a piè di pagina, citazioni, ammonizioni personalizzate, riferimenti incrociati API - senza richiedere estensioni separate. Il generatore di documentazione Sphinx utilizza .rst come formato sorgente nativo e produce la documentazione ufficiale di Python, NumPy, Django e del kernel Linux a partire da file sorgente .rst.

I file sono in testo semplice UTF-8 senza struttura binaria o magic bytes, modificabili in qualsiasi editor di testo. Il processore standard è Docutils, che converte .rst in HTML, LaTeX, PDF e altri formati tramite strumenti da riga di comando come rst2html e rst2latex. I grandi progetti Sphinx collegano centinaia di singoli file sorgente .rst attraverso le direttive .. toctree::.

Il tipo MIME comunemente in uso è text/x-rst; l'unico tipo registrato IANA, text/prs.fallenstein.rst, non è riconosciuto dal progetto Docutils stesso. reStructuredText è attivamente mantenuto, sebbene i progetti più recenti adottino sempre più alternative basate su Markdown come MyST per flussi di lavoro di documentazione più leggeri.