Wat is het RST-bestandsformaat?
.rst is een lichtgewicht markup-formaat in platte tekst dat primair wordt gebruikt voor technische documentatie in het Python-ecosysteem. Bestanden gebruiken een menselijk leesbare syntaxis: sectiekoppen worden gemaakt door de titeltekst te onderstrepen met tekens zoals =, -, of ~; codevoorbeelden worden geïntroduceerd met .. code-block:: instructies; kruisverwijzingen gebruiken de :role: syntaxis; en inhoudsopgaven van documenten worden opgebouwd met .. toctree:: instructies.
Vergeleken met Markdown biedt .rst een formeel systeem van instructies en rollen dat rijkere semantische markup mogelijk maakt - voetnoten, citaten, aangepaste vermaningen, API-kruisverwijzingen - zonder dat er afzonderlijke extensies nodig zijn. De Sphinx-documentatiegenerator gebruikt .rst als zijn eigen bronformaat en produceert de officiële documentatie voor Python, NumPy, Django en de Linux-kernel vanuit .rst-bronbestanden.
Bestanden zijn UTF-8 platte tekst zonder binaire structuur of magic bytes, bewerkbaar in elke teksteditor. De standaardprocessor is Docutils, die .rst converteert naar HTML, LaTeX, PDF en andere uitvoer via opdrachtregelprogramma's zoals rst2html en rst2latex. Grote Sphinx-projecten koppelen honderden individuele .rst-bronbestanden via .. toctree:: instructies.
Het MIME-type dat algemeen in gebruik is, is text/x-rst; het enige door IANA geregistreerde type, text/prs.fallenstein.rst, wordt niet erkend door het Docutils-project zelf. reStructuredText wordt actief onderhouden, hoewel nieuwere projecten steeds vaker overstappen op Markdown-gebaseerde alternatieven zoals MyST voor lichtere documentatieworkflows.
Beveiliging & veiligheid
RISICO: LOWRST-bestanden zijn platte tekst en kunnen zelf geen code uitvoeren, dus het openen ervan is veilig. De enige waarschuwing: Sphinx-instructies kunnen onbewerkte HTML (.. raw:: html) bevatten die in een browser wordt gerenderd - gerenderde uitvoer van een niet-vertrouwde RST-bron kan actieve HTML/JS bevatten. Beperk u tot het lezen van de onbewerkte bron of een gesandboxte renderer als de herkomst onbekend is.
Formaatdetails
in een notendop- IBM VoiceType Script File - Verouderd IBM VoiceType-spraakherkenningsscript (IBM-product uit de jaren 90); feitelijk uitgestorven.
- Abaqus Results File - Abaqus FEA-simulatie binair herstart/resultatenbestand, niet gerelateerd aan tekst-markup (binair formaat met .rst extensie).
Programma's die RST-bestanden openen
Windows5 apps
Windows Notepad
Ingebouwd Opent de onbewerkte RST-tekst voor snel lezen en bewerken - geen syntax-highlighting of voorbeeld. 
Notepad
Open-source Open de .rst - Notepad++ heeft community UDL (user-defined language) voor RST-syntax-highlighting. Lichtgewicht bewerking zonder voorbeeld. 
Visual Studio Code
Gratis Installeer de „reStructuredText”-extensie (lextudio.restructuredtext) voor syntax-highlighting en een live HTML-voorbeeld via het RST-voorbeeldvenster. 
Sphinx (sphinx-build)
Open-source Voer „sphinx-build -b html docs/ _build/html” uit om .rst-bestanden te renderen naar een volledige HTML-documentatiewebsite. Installeer via pip install sphinx.
Docutils (rst2html)
Open-source Voer „rst2html file.rst file.html” uit om een enkele .rst naar HTML te converteren. Installeer via pip install docutils. 
macOS3 apps
TextEdit
Ingebouwd Open de .rst als platte tekst (gebruik Opmaak > Maak platte tekst om RTF-conversie te voorkomen). Geen voorbeeld.
Visual Studio Code
Gratis Installeer de „reStructuredText”-extensie (lextudio.restructuredtext) voor syntax-highlighting en een live HTML-voorbeeld via het RST-voorbeeldvenster.
Sphinx (sphinx-build)
Open-source Voer „sphinx-build -b html docs/ _build/html” uit om .rst-bestanden te renderen naar een volledige HTML-documentatiewebsite. Installeer via pip install sphinx. 
Linux3 apps
Visual Studio Code
Gratis Installeer de „reStructuredText”-extensie (lextudio.restructuredtext) voor syntax-highlighting en een live HTML-voorbeeld via het RST-voorbeeldvenster.
gVim / Vim
Open-source Vim bevat RST-syntax-highlighting; de rst.vim-plugin voegt folding en voorbeelden toe.
Sphinx (sphinx-build)
Open-source Voer „sphinx-build -b html docs/ _build/html” uit om .rst-bestanden te renderen naar een volledige HTML-documentatiewebsite. Installeer via pip install sphinx.
Read the Docs
Gratis Host een Sphinx/RST-project op readthedocs.org om het te renderen en te publiceren als een doorzoekbare HTML-documentatiewebsite. Technische details
diepe specificaties| Codering | Platte tekst, UTF-8 (ASCII-compatibel; Windows-bestanden kunnen een UTF-8 BOM bevatten) |
| Sectiekoppen | Onderstreep (en optioneel bovenstreep) titeltekst met =, -, ~, ^, of andere leestekens |
| Instructies | .. directive-name:: syntaxis voor codeblokken, afbeeldingen, notities, toctrees en aangepaste extensies |
| Inline rollen | `:role:` syntaxis voor semantische kruisverwijzingen, afkortingen en wiskunde |
| Inhoudsopgave | .. toctree:: instructie (Sphinx) koppelt meerdere .rst-bestanden in een navigeerbare documentstructuur |
| Standaardprocessor | Docutils (rst2html, rst2latex, rst2pdf, rst2xml) |
| Sphinx-extensies | Sphinx voegt :ref:, :doc:, autodoc en andere projectspecifieke instructies toe bovenop de kern van RST |
| MIME-type | text/x-rst (de facto); text/prs.fallenstein.rst (IANA-geregistreerd, zelden gebruikt) |
| Handtekening / magic bytes | Geen - platte-tekstbestand zonder binaire header |
| Primair ecosysteem | Python-documentatie (officiële Python-docs, NumPy, Django, Linux-kernel-docs, Read the Docs) |
| Typische grootte | 1 KB - 500 KB per bronbestand; grote Sphinx-projecten kunnen honderden .rst-bestanden bevatten |
| Uitgebracht | 2002 (David Goodger, first release April 2, 2002) |
| Laatste versie | Docutils 0.21 (2024); no separate RST format version number |
| Open standaard | Ja · royaltyvrij |
| Specificatie | docutils.sourceforge.io |
RST conversies
Community V&A
gevraagd door gebruikersNog geen vragen - wees de eerste om iets te vragen over RST-bestanden.
