Hva er RST-filformatet?
.rst er et lettvekts markeringsformat for ren tekst som primært brukes til teknisk dokumentasjon i Python-økosystemet. Filer bruker en menneskevennlig syntaks: seksjonsoverskrifter opprettes ved å understreke titteltekst med tegn som =, - eller ~; kodeeksempler introduseres med .. code-block::-direktiver; kryssreferanser bruker :role:-syntaks; og dokumentets innholdsfortegnelser bygges med .. toctree::-direktiver.
Sammenlignet med Markdown, tilbyr .rst et formelt direktiv- og rollesystem som muliggjør rikere semantisk markering - fotnoter, sitater, egendefinerte merknader, API-kryssreferanser - uten å kreve separate utvidelser. Sphinx-dokumentasjonsgeneratoren bruker .rst som sitt naturlige kildeformat og produserer den offisielle dokumentasjonen for Python, NumPy, Django og Linux-kjernen fra .rst-kildefiler.
Filer er UTF-8 ren tekst uten binær struktur eller «magic bytes», og kan redigeres i alle tekstredigeringsprogrammer. Standardprosessoren er Docutils, som konverterer .rst til HTML, LaTeX, PDF og andre formater via kommandolinjeverktøy som rst2html og rst2latex. Store Sphinx-prosjekter kobler sammen hundrevis av individuelle .rst-kildefiler gjennom .. toctree::-direktiver.
MIME-typen som vanligvis brukes er text/x-rst; den eneste IANA-registrerte typen, text/prs.fallenstein.rst, anerkjennes ikke av Docutils-prosjektet selv. reStructuredText vedlikeholdes aktivt, selv om nyere prosjekter i økende grad tar i bruk Markdown-baserte alternativer som MyST for lettere dokumentasjonsarbeidsflyter.
Sikkerhet og trygghet
RISIKO: LOWRST-filer er ren tekst og kan ikke kjøre kode på egen hånd, så det er trygt å åpne dem. Den eneste advarselen: Sphinx-direktiver kan inkludere rå HTML (.. raw:: html) som rendres i en nettleser - rendret utdata fra en upålitelig RST-kilde kan inneholde aktiv HTML/JS. Hold deg til å lese råkilden eller en sandkasse-rendrer hvis opprinnelsen er ukjent.
Formatdetaljer
i et nøtteskall- IBM VoiceType Script File - Legacy IBM VoiceType speech-recognition script (1990s IBM product); effectively extinct.
- Abaqus Results File - Abaqus FEA simulation binary restart/results file, unrelated to text markup (binary format with .rst extension).
Programmer som åpner RST-filer
Windows5 apps
Windows Notepad
Innebygd Åpner den rå RST-teksten for rask lesing og redigering - ingen syntaksutheving eller forhåndsvisning. 
Notepad
Åpen kildekode Åpne .rst - Notepad++ har fellesskaps-UDL (brukerdefinert språk) for RST-syntaksutheving. Lettvektsredigering uten forhåndsvisning. 
Visual Studio Code
Gratis Installer «reStructuredText»-utvidelsen (lextudio.restructuredtext) for syntaksutheving og en direkte HTML-forhåndsvisning via RST-forhåndsvisningspanelet. 
Sphinx (sphinx-build)
Åpen kildekode Kjør «sphinx-build -b html docs/ _build/html» for å rendre .rst-filer til et komplett HTML-dokumentasjonsnettsted. Installer via pip install sphinx.
Docutils (rst2html)
Åpen kildekode Kjør «rst2html file.rst file.html» for å konvertere en enkelt .rst til HTML. Installer via pip install docutils. 
macOS3 apps
TextEdit
Innebygd Åpne .rst som ren tekst (bruk Format > Gjør om til ren tekst for å forhindre RTF-konvertering). Ingen forhåndsvisning.
Visual Studio Code
Gratis Installer «reStructuredText»-utvidelsen (lextudio.restructuredtext) for syntaksutheving og en direkte HTML-forhåndsvisning via RST-forhåndsvisningspanelet.
Sphinx (sphinx-build)
Åpen kildekode Kjør «sphinx-build -b html docs/ _build/html» for å rendre .rst-filer til et komplett HTML-dokumentasjonsnettsted. Installer via pip install sphinx. 
Linux3 apps
Visual Studio Code
Gratis Installer «reStructuredText»-utvidelsen (lextudio.restructuredtext) for syntaksutheving og en direkte HTML-forhåndsvisning via RST-forhåndsvisningspanelet.
gVim / Vim
Åpen kildekode Vim inkluderer RST-syntaksutheving; rst.vim-programtillegget legger til folding og forhåndsvisning.
Sphinx (sphinx-build)
Åpen kildekode Kjør «sphinx-build -b html docs/ _build/html» for å rendre .rst-filer til et komplett HTML-dokumentasjonsnettsted. Installer via pip install sphinx.
Read the Docs
Gratis Host et Sphinx/RST-prosjekt på readthedocs.org for å rendre og publisere det som et søkbart HTML-dokumentasjonsnettsted. Tekniske detaljer
dyp spesifikasjon| Koding | Ren tekst, UTF-8 (ASCII-kompatibel; Windows-filer kan ha en UTF-8 BOM) |
| Seksjonsoverskrifter | Understrek (og valgfritt overstrek) titteltekst med =, -, ~, ^ eller andre tegnsettingstegn |
| Direktiver | .. direktiv-navn:: syntaks for kodeblokker, bilder, notater, toctrees og egendefinerte utvidelser |
| Innebygde roller | «:role:»-syntaks for semantiske kryssreferanser, forkortelser og matematikk |
| Innholdsfortegnelse | .. toctree:: direktiv (Sphinx) kobler flere .rst-filer sammen i et navigerbart dokumenttre |
| Standardprosessor | Docutils (rst2html, rst2latex, rst2pdf, rst2xml) |
| Sphinx-utvidelser | Sphinx legger til :ref:, :doc:, autodoc og andre prosjektspesifikke direktiver på toppen av kjerne-RST |
| MIME-type | text/x-rst (de facto); text/prs.fallenstein.rst (IANA-registrert, sjelden brukt) |
| Signatur / magic bytes | Ingen - ren tekstfil uten binær header |
| Primært økosystem | Python-dokumentasjon (offisielle Python-dokumenter, NumPy, Django, Linux-kjernedokumentasjon, Read the Docs) |
| Typisk størrelse | 1 KB - 500 KB per kildefil; store Sphinx-prosjekter kan inneholde hundrevis av .rst-filer |
| Utgitt | 2002 (David Goodger, first release April 2, 2002) |
| Siste versjon | Docutils 0.21 (2024); no separate RST format version number |
| Åpen standard | Ja · royalty-fri |
| Spesifikasjon | docutils.sourceforge.io |
RST-konverteringer
Spørsmål og svar fra fellesskapet
spurt av brukereIngen spørsmål ennå - vær den første til å spørre om RST-filer.
