Was ist das RST-Dateiformat?
.rst ist ein leichtgewichtiges Klartext-Markup-Format, das primär für technische Dokumentationen im Python-Ökosystem genutzt wird. Dateien verwenden eine menschenlesbare Syntax: Abschnittsüberschriften werden durch Unterstreichen des Titeltexts mit Zeichen wie =, - oder ~ erstellt; Code-Beispiele werden mit .. code-block::-Direktiven eingeleitet; Querverweise nutzen die :role:-Syntax; und Inhaltsverzeichnisse werden mit .. toctree::-Direktiven aufgebaut.
Im Vergleich zu Markdown bietet .rst ein formales System für Direktiven und Rollen, das ein reichhaltigeres semantisches Markup ermöglicht - Fußnoten, Zitate, benutzerdefinierte Ermahnungen (Admonitions), API-Querverweise - ohne dass separate Erweiterungen erforderlich sind. Der Dokumentationsgenerator Sphinx verwendet .rst als natives Quellformat und erstellt die offiziellen Dokumentationen für Python, NumPy, Django und den Linux-Kernel aus .rst-Quelldateien.
Dateien sind UTF-8-Klartext ohne binäre Struktur oder Magic Bytes und können in jedem Texteditor bearbeitet werden. Der Standard-Prozessor ist Docutils, der .rst über Kommandozeilen-Tools wie rst2html und rst2latex in HTML, LaTeX, PDF und andere Formate konvertiert. Große Sphinx-Projekte verknüpfen hunderte einzelner .rst-Quelldateien über .. toctree::-Direktiven.
Der gebräuchliche MIME-Typ ist text/x-rst; der einzige bei der IANA registrierte Typ, text/prs.fallenstein.rst, wird vom Docutils-Projekt selbst nicht anerkannt. reStructuredText wird aktiv gepflegt, obwohl neuere Projekte zunehmend Markdown-basierte Alternativen wie MyST für leichtere Dokumentations-Workflows einsetzen.
Sicherheit
RISIKO: LOWRST-Dateien sind Klartext und können von sich aus keinen Code ausführen, daher ist das Öffnen sicher. Einziger Vorbehalt: Sphinx-Direktiven können rohes HTML (.. raw:: html) enthalten, das in einem Browser gerendert wird - gerenderte Ausgaben aus einer nicht vertrauenswürdigen RST-Quelle könnten aktives HTML/JS enthalten. Beschränken Sie sich auf das Lesen des rohen Quellcodes oder einen Sandbox-Renderer, wenn die Herkunft unbekannt ist.
Formatdetails
kurz gefasst- IBM VoiceType Script File - Veraltetes IBM VoiceType Spracherkennungs-Skript (IBM-Produkt der 1990er Jahre); praktisch ausgestorben.
- Abaqus Results File - Binäre Neustart-/Ergebnisdatei der Abaqus FEA-Simulation, nicht verwandt mit Text-Markup (binäres Format mit der Endung .rst).
Programme zum Öffnen von RST-Dateien
Windows5 apps
Windows Notepad
Integriert Öffnet den rohen RST-Text zum schnellen Lesen und Bearbeiten - keine Syntax-Hervorhebung oder Vorschau. 
Notepad
Open Source Öffnet die .rst - Notepad++ verfügt über Community-UDL (User Defined Language) für RST-Syntax-Hervorhebung. Leichtgewichtige Bearbeitung ohne Vorschau. 
Visual Studio Code
Kostenlos Installieren Sie die Erweiterung „reStructuredText” (lextudio.restructuredtext) für Syntax-Hervorhebung und eine Live-HTML-Vorschau über das RST-Vorschaufenster. 
Sphinx (sphinx-build)
Open Source Führen Sie „sphinx-build -b html docs/ _build/html” aus, um .rst-Dateien in eine vollständige HTML-Dokumentationsseite zu rendern. Installation via pip install sphinx.
Docutils (rst2html)
Open Source Führen Sie „rst2html datei.rst datei.html” aus, um eine einzelne .rst-Datei in HTML zu konvertieren. Installation via pip install docutils. 
macOS3 apps
TextEdit
Integriert Öffnet die .rst als Klartext (verwenden Sie Format > In reinen Text umwandeln, um eine RTF-Konvertierung zu verhindern). Keine Vorschau.
Visual Studio Code
Kostenlos Installieren Sie die Erweiterung „reStructuredText” (lextudio.restructuredtext) für Syntax-Hervorhebung und eine Live-HTML-Vorschau über das RST-Vorschaufenster.
Sphinx (sphinx-build)
Open Source Führen Sie „sphinx-build -b html docs/ _build/html” aus, um .rst-Dateien in eine vollständige HTML-Dokumentationsseite zu rendern. Installation via pip install sphinx. 
Linux3 apps
Visual Studio Code
Kostenlos Installieren Sie die Erweiterung „reStructuredText” (lextudio.restructuredtext) für Syntax-Hervorhebung und eine Live-HTML-Vorschau über das RST-Vorschaufenster.
gVim / Vim
Open Source Vim enthält RST-Syntax-Hervorhebung; das Plugin rst.vim fügt Code-Faltung und Vorschau hinzu.
Sphinx (sphinx-build)
Open Source Führen Sie „sphinx-build -b html docs/ _build/html” aus, um .rst-Dateien in eine vollständige HTML-Dokumentationsseite zu rendern. Installation via pip install sphinx.
Read the Docs
Kostenlos Hosten Sie ein Sphinx/RST-Projekt auf readthedocs.org, um es als durchsuchbare HTML-Dokumentationsseite zu rendern und zu veröffentlichen. Technische Details
technische Spezifikation| Kodierung | Klartext, UTF-8 (ASCII-kompatibel; Windows-Dateien können ein UTF-8 BOM enthalten) |
| Abschnittsüberschriften | Unterstreichen (und optional Überstreichen) des Titeltexts mit =, -, ~, ^ oder anderen Satzzeichen |
| Direktiven | `.. direktiven-name::` Syntax für Code-Blöcke, Bilder, Notizen, Inhaltsverzeichnisse und benutzerdefinierte Erweiterungen |
| Inline-Rollen | `:role:` Syntax für semantische Querverweise, Abkürzungen und Mathematik |
| Inhaltsverzeichnis | Die `.. toctree::`-Direktive (Sphinx) verknüpft mehrere .rst-Dateien zu einem navigierbaren Dokumentenbaum |
| Standard-Prozessor | Docutils (rst2html, rst2latex, rst2pdf, rst2xml) |
| Sphinx-Erweiterungen | Sphinx fügt :ref:, :doc:, autodoc und andere projektspezifische Direktiven über den RST-Kern hinzu |
| MIME-Typ | text/x-rst (de facto); text/prs.fallenstein.rst (IANA-registriert, selten verwendet) |
| Signatur / Magic Bytes | Keine - Klartextdatei ohne binären Header |
| Primäres Ökosystem | Python-Dokumentation (offizielle Python-Docs, NumPy, Django, Linux-Kernel-Docs, Read the Docs) |
| Typische Größe | 1 KB - 500 KB pro Quelldatei; große Sphinx-Projekte können hunderte von .rst-Dateien enthalten |
| Veröffentlicht | 2002 (David Goodger, first release April 2, 2002) |
| Neueste Version | Docutils 0.21 (2024); no separate RST format version number |
| Offener Standard | Ja · lizenzgebührenfrei |
| Spezifikation | docutils.sourceforge.io |
RST-Konvertierungen
Community Q&A
von Nutzern gefragtNoch keine Fragen - stellen Sie die erste Frage zu RST-Dateien.
Häufig gestellte Fragen
Was ist eine RST-Datei?
Wie öffne ich eine RST-Datei?
pip install docutils).Wie konvertiere ich RST in HTML oder PDF?
pip install docutils) und führen Sie „rst2html datei.rst datei.html” aus, oder nutzen Sie Pandoc. Für eine komplette Dokumentations-Website erstellt Sphinx HTML und PDF aus mehreren RST-Dateien. Das kostenlose Tool rst2pdf konvertiert RST direkt in PDF ohne den Umweg über LaTeX.Was ist der Unterschied zwischen RST und Markdown?
.. code-block::, .. toctree::) und Rollen (:ref:, :func:) für komplexe Querverweise. Markdown ist einfacher und weiter verbreitet für allgemeine Texte (READMEs, Notizen). Sphinx nutzt RST nativ, kann aber auch Markdown (via MyST) verwenden.Warum befindet sich eine RST-Datei in dem von mir heruntergeladenen Python-Paket?
README.rst ist die traditionelle Readme-Datei für Python-Pakete, die auf PyPI veröffentlicht werden - sie wird auf der PyPI-Paketseite angezeigt. Moderne Pakete verwenden zunehmend README.md, aber RST ist in älteren und wissenschaftlichen Python-Paketen immer noch verbreitet.
