Vad är filformatet RST?
.rst är ett lättviktsformat för textformatering som främst används för teknisk dokumentation inom Python-ekosystemet. Filer använder en läsbar syntax: sektionsrubriker skapas genom att understryka rubriktexten med tecken som =, - eller ~; kodexempel introduceras med .. code-block::-direktiv; korsreferenser använder :role:-syntax; och innehållsförteckningar byggs med .. toctree::-direktiv.
Jämfört med Markdown erbjuder .rst ett formellt system för direktiv och roller som möjliggör rikare semantisk märkning - fotnoter, citat, anpassade varningar, API-korsreferenser - utan att kräva separata tillägg. Dokumentationsgeneratorn Sphinx använder .rst som sitt infödda källformat och producerar den officiella dokumentationen för Python, NumPy, Django och Linux-kärnan från .rst-källfiler.
Filer är vanlig text i UTF-8 utan binär struktur eller magic bytes, och kan redigeras i valfri textredigerare. Standardprocessorn är Docutils, som konverterar .rst till HTML, LaTeX, PDF och andra format via kommandoradsverktyg som rst2html och rst2latex. Stora Sphinx-projekt länkar samman hundratals individuella .rst-källfiler via .. toctree::-direktiv.
Den MIME-typ som används i allmänhet är text/x-rst; den enda IANA-registrerade typen, text/prs.fallenstein.rst, erkänns inte av Docutils-projektet självt. reStructuredText underhålls aktivt, även om nyare projekt i allt högre grad använder Markdown-baserade alternativ som MyST för enklare dokumentationsflöden.
Säkerhet & trygghet
RISK: LOWRST-filer är vanlig text och kan inte köra kod på egen hand, så de är säkra att öppna. Den enda varningen: Sphinx-direktiv kan inkludera rå HTML (.. raw:: html) som renderas i en webbläsare - renderat resultat från en okänd RST-källa kan innehålla aktiv HTML/JS. Håll dig till att läsa källkoden eller använd en sandlåderenderare om ursprunget är okänt.
Formatdetaljer
i ett nötskal- IBM VoiceType Script File - Gammalt skript för IBM VoiceType taligenkänning (IBM-produkt från 1990-talet); i praktiken utdött.
- Abaqus Results File - Binär omstarts-/resultatfil för Abaqus FEA-simulering, ej relaterad till textformatering (binärt format med filändelsen .rst).
Program som öppnar RST-filer
Windows5 apps
Windows Notepad
Inbyggd Öppnar den råa RST-texten för snabb läsning och redigering - ingen syntaxmarkering eller förhandsvisning. 
Notepad
Öppen källkod Öppna .rst - Notepad++ har community-baserad UDL (user-defined language) för RST-syntaxmarkering. Lättviktsredigering utan förhandsvisning. 
Visual Studio Code
Gratis Installera tillägget «reStructuredText» (lextudio.restructuredtext) för syntaxmarkering och en live HTML-förhandsvisning via RST-förhandsgranskningsfönstret. 
Sphinx (sphinx-build)
Öppen källkod Kör «sphinx-build -b html docs/ _build/html» för att rendera .rst-filer till en komplett HTML-dokumentationswebbplats. Installera via pip install sphinx.
Docutils (rst2html)
Öppen källkod Kör «rst2html fil.rst fil.html» för att konvertera en enskild .rst till HTML. Installera via pip install docutils. 
macOS3 apps
TextEdit
Inbyggd Öppna .rst som vanlig text (använd Format > Gör till ren text för att förhindra RTF-konvertering). Ingen förhandsvisning.
Visual Studio Code
Gratis Installera tillägget «reStructuredText» (lextudio.restructuredtext) för syntaxmarkering och en live HTML-förhandsvisning via RST-förhandsgranskningsfönstret.
Sphinx (sphinx-build)
Öppen källkod Kör «sphinx-build -b html docs/ _build/html» för att rendera .rst-filer till en komplett HTML-dokumentationswebbplats. Installera via pip install sphinx. 
Linux3 apps
Visual Studio Code
Gratis Installera tillägget «reStructuredText» (lextudio.restructuredtext) för syntaxmarkering och en live HTML-förhandsvisning via RST-förhandsgranskningsfönstret.
gVim / Vim
Öppen källkod Vim inkluderar syntaxmarkering för RST; insticksprogrammet rst.vim lägger till kodfällning och förhandsvisning.
Sphinx (sphinx-build)
Öppen källkod Kör «sphinx-build -b html docs/ _build/html» för att rendera .rst-filer till en komplett HTML-dokumentationswebbplats. Installera via pip install sphinx.
Read the Docs
Gratis Hysa ett Sphinx/RST-projekt på readthedocs.org för att rendera och publicera det som en sökbar HTML-dokumentationswebbplats. Tekniska detaljer
djup specifikation| Kodning | Vanlig text, UTF-8 (ASCII-kompatibel; Windows-filer kan ha en UTF-8 BOM) |
| Sektionsrubriker | Understrykning (och valfritt överstrykning) av rubriktext med =, -, ~, ^ eller andra skiljetecken |
| Direktiv | .. direktiv-namn:: syntax för kodblock, bilder, anteckningar, toctrees och anpassade tillägg |
| Inline-roller | `:role:`-syntax för semantiska korsreferenser, förkortningar och matematik |
| Innehållsförteckning | .. toctree:: direktiv (Sphinx) länkar flera .rst-filer till ett navigerbart dokumentträd |
| Standardprocessor | Docutils (rst2html, rst2latex, rst2pdf, rst2xml) |
| Sphinx-tillägg | Sphinx lägger till :ref:, :doc:, autodoc och andra projektspecifika direktiv ovanpå kärnan i RST |
| MIME-typ | text/x-rst (de facto); text/prs.fallenstein.rst (IANA-registrerad, används sällan) |
| Signatur / magic bytes | Ingen - vanlig textfil utan binärt huvud |
| Primärt ekosystem | Python-dokumentation (officiell Python-dokumentation, NumPy, Django, Linux-kärnan, Read the Docs) |
| Typisk storlek | 1 KB - 500 KB per källfil; stora Sphinx-projekt kan innehålla hundratals .rst-filer |
| Släppt | 2002 (David Goodger, first release April 2, 2002) |
| Senaste version | Docutils 0.21 (2024); no separate RST format version number |
| Öppen standard | Ja · royaltyfri |
| Specifikation | docutils.sourceforge.io |
RST-konverteringar
Frågor & svar
frågat av användareInga frågor än - bli den första att fråga om RST-filer.
