Hvad er RST-filformatet?
.rst er et letvægts-markup-format i almindelig tekst, der primært bruges til teknisk dokumentation i Python-økosystemet. Filer bruger en læsbar syntaks: sektionsoverskrifter oprettes ved at understrege titlen med tegn som =, - eller ~; kodeeksempler introduceres med .. code-block::-direktiver; krydsreferencer bruger :role:-syntaks; og dokumenters indholdsfortegnelser bygges med .. toctree::-direktiver.
Sammenlignet med Markdown tilbyder .rst et formelt direktiv- og rollesystem, der muliggør rigere semantisk markup - fodnoter, citater, brugerdefinerede bemærkninger, API-krydsreferencer - uden at kræve separate udvidelser. Sphinx-dokumentationsgeneratoren bruger .rst som sit indfødte kildeformat og producerer den officielle Python-, NumPy-, Django- og Linux-kernedokumentation fra .rst-kildefiler.
Filerne er UTF-8 almindelig tekst uden binær struktur eller magic bytes, og de kan redigeres i enhver teksteditor. Standardprocessoren er Docutils, som konverterer .rst til HTML, LaTeX, PDF og andre formater via kommandolinjeværktøjer som rst2html og rst2latex. Store Sphinx-projekter linker hundreder af individuelle .rst-kildefiler sammen via .. toctree::-direktiver.
Den MIME-type, der er i almindelig brug, er text/x-rst; den eneste IANA-registrerede type, text/prs.fallenstein.rst, anerkendes ikke af selve Docutils-projektet. reStructuredText vedligeholdes aktivt, selvom nyere projekter i stigende grad tager Markdown-baserede alternativer som MyST i brug til lettere dokumentationsarbejdsgange.
Sikkerhed og tryghed
RISIKO: LOWRST-filer er almindelig tekst og kan ikke udføre kode i sig selv, så det er sikkert at åbne dem. Den eneste advarsel: Sphinx-direktiver kan inkludere rå HTML (.. raw:: html), der renderes i en browser - rendered output fra en upålidelig RST-kilde kan indeholde aktiv HTML/JS. Hold dig til at læse den rå kildekode eller brug en sandboxed renderer, hvis oprindelsen er ukendt.
Formatdetaljer
kort fortalt- IBM VoiceType Script File - Gammelt IBM VoiceType-talegenkendelsesscript (IBM-produkt fra 1990'erne); reelt uddødt.
- Abaqus Results File - Abaqus FEA-simulerings binær genstarts-/resultatfil, ikke relateret til tekst-markup (binært format med .rst-filendelse).
Programmer der åbner RST-filer
Windows5 apps
Windows Notepad
Indbygget Åbner den rå RST-tekst til hurtig læsning og redigering - ingen syntaksfremhævning eller forhåndsvisning. 
Notepad
Open-source Åbn .rst - Notepad++ har brugerdefinerede sprogindstillinger (UDL) til RST-syntaksfremhævning. Letvægtsredigering uden forhåndsvisning. 
Visual Studio Code
Gratis Installer «reStructuredText»-udvidelsen (lextudio.restructuredtext) for syntaksfremhævning og en live HTML-forhåndsvisning via RST-visningsruden. 
Sphinx (sphinx-build)
Open-source Kør «sphinx-build -b html docs/ _build/html» for at rendere .rst-filer til et komplet HTML-dokumentationswebsted. Installer via pip install sphinx.
Docutils (rst2html)
Open-source Kør «rst2html fil.rst fil.html» for at konvertere en enkelt .rst til HTML. Installer via pip install docutils. 
macOS3 apps
TextEdit
Indbygget Åbn .rst som almindelig tekst (brug Format > Gør til ren tekst for at forhindre RTF-konvertering). Ingen forhåndsvisning.
Visual Studio Code
Gratis Installer «reStructuredText»-udvidelsen (lextudio.restructuredtext) for syntaksfremhævning og en live HTML-forhåndsvisning via RST-visningsruden.
Sphinx (sphinx-build)
Open-source Kør «sphinx-build -b html docs/ _build/html» for at rendere .rst-filer til et komplet HTML-dokumentationswebsted. Installer via pip install sphinx. 
Linux3 apps
Visual Studio Code
Gratis Installer «reStructuredText»-udvidelsen (lextudio.restructuredtext) for syntaksfremhævning og en live HTML-forhåndsvisning via RST-visningsruden.
gVim / Vim
Open-source Vim inkluderer RST-syntaksfremhævning; rst.vim-plugin tilføjer foldning og forhåndsvisning.
Sphinx (sphinx-build)
Open-source Kør «sphinx-build -b html docs/ _build/html» for at rendere .rst-filer til et komplet HTML-dokumentationswebsted. Installer via pip install sphinx.
Read the Docs
Gratis Host et Sphinx/RST-projekt på readthedocs.org for at rendere og udgive det som et søgbart HTML-dokumentationswebsted. Tekniske detaljer
dyb specifikation| Kodning | Almindelig tekst, UTF-8 (ASCII-kompatibel; Windows-filer kan have en UTF-8 BOM) |
| Sektionsoverskrifter | Understreg (og valgfrit overstreg) titlen med =, -, ~, ^ eller andre tegnsætningstegn |
| Direktiver | .. direktiv-navn:: syntaks til kodeblokke, billeder, noter, toctrees og brugerdefinerede udvidelser |
| Inline-roller | `:role:`-syntaks til semantiske krydsreferencer, forkortelser og matematik |
| Indholdsfortegnelse | .. toctree:: direktiv (Sphinx) linker flere .rst-filer sammen i et navigerbart dokumenttræ |
| Standardprocessor | Docutils (rst2html, rst2latex, rst2pdf, rst2xml) |
| Sphinx-udvidelser | Sphinx tilføjer :ref:, :doc:, autodoc og andre projektspecifikke direktiver oven på kerne-RST |
| MIME-type | text/x-rst (de facto); text/prs.fallenstein.rst (IANA-registreret, sjældent brugt) |
| Signatur / magic bytes | Ingen - almindelig tekstfil uden binær header |
| Primært økosystem | Python-dokumentation (officielle Python-docs, NumPy, Django, Linux-kernedocs, Read the Docs) |
| Typisk størrelse | 1 KB - 500 KB pr. kildefil; store Sphinx-projekter kan indeholde hundreder af .rst-filer |
| Udgivet | 2002 (David Goodger, first release April 2, 2002) |
| Seneste version | Docutils 0.21 (2024); no separate RST format version number |
| Åben standard | Ja · royaltyfri |
| Specifikation | docutils.sourceforge.io |
RST-konverteringer
Fællesskabets Q&A
spurgt af brugereIngen spørgsmål endnu - vær den første til at spørge om RST-filer.
