Co to jest format pliku RST?
.rst to lekki format znaczników w formacie czystego tekstu, używany głównie do dokumentacji technicznej w ekosystemie Python. Pliki wykorzystują składnię czytelną dla człowieka: nagłówki sekcji są tworzone przez podkreślenie tekstu tytułu znakami takimi jak =, - lub ~; próbki kodu są wprowadzane za pomocą dyrektyw .. code-block::; odsyłacze używają składni :role:; a spisy treści dokumentów są budowane za pomocą dyrektyw .. toctree::.
W porównaniu do Markdown, .rst zapewnia formalny system dyrektyw i ról, który umożliwia bogatsze znaczniki semantyczne - przypisy, cytaty, niestandardowe upomnienia, odsyłacze API - bez konieczności stosowania oddzielnych rozszerzeń. Generator dokumentacji Sphinx używa .rst jako natywnego formatu źródłowego i tworzy oficjalną dokumentację Python, NumPy, Django oraz jądra Linux z plików źródłowych .rst.
Pliki są zwykłym tekstem UTF-8 bez struktury binarnej ani magic bytes, edytowalnym w dowolnym edytorze tekstu. Standardowym procesorem jest Docutils, który konwertuje .rst na HTML, LaTeX, PDF i inne formaty wyjściowe za pomocą narzędzi wiersza poleceń, takich jak rst2html i rst2latex. Duże projekty Sphinx łączą setki poszczególnych plików źródłowych .rst poprzez dyrektywy .. toctree::.
Powszechnie używanym typem MIME jest text/x-rst; jedyny typ zarejestrowany w IANA, text/prs.fallenstein.rst, nie jest uznawany przez sam projekt Docutils. reStructuredText jest aktywnie rozwijany, choć nowsze projekty coraz częściej przyjmują alternatywy oparte na Markdown, takie jak MyST, dla lżejszych przepływów pracy z dokumentacją.
Bezpieczeństwo
RYZYKO: LOWPliki RST są zwykłym tekstem i nie mogą same w sobie wykonywać kodu, więc ich otwieranie jest bezpieczne. Jedyna uwaga: dyrektywy Sphinx mogą zawierać surowy HTML (.. raw:: html), który renderuje się w przeglądarce - wyrenderowany wynik z niezaufanego źródła RST może zawierać aktywny kod HTML/JS. Trzymaj się czytania surowego źródła lub renderera w piaskownicy, jeśli pochodzenie pliku jest nieznane.
Szczegóły formatu
w pigułce- IBM VoiceType Script File - Starszy skrypt rozpoznawania mowy IBM VoiceType (produkt IBM z lat 90.); praktycznie wymarły.
- Abaqus Results File - Binarny plik restartu/wyników symulacji Abaqus FEA, niezwiązany ze znacznikami tekstowymi (format binarny z rozszerzeniem .rst).
Programy otwierające pliki RST
Windows5 apps
Windows Notepad
Wbudowany Otwiera surowy tekst RST do szybkiego odczytu i edycji - brak podświetlania składni i podglądu. 
Notepad
Open-source Otwórz .rst - Notepad++ posiada społecznościowe UDL (język zdefiniowany przez użytkownika) dla podświetlania składni RST. Lekka edycja bez podglądu. 
Visual Studio Code
Darmowy Zainstaluj rozszerzenie „reStructuredText” (lextudio.restructuredtext), aby uzyskać podświetlanie składni i podgląd HTML na żywo przez panel podglądu RST. 
Sphinx (sphinx-build)
Open-source Uruchom „sphinx-build -b html docs/ _build/html”, aby wyrenderować pliki .rst do pełnej witryny dokumentacji HTML. Zainstaluj przez pip install sphinx.
Docutils (rst2html)
Open-source Uruchom „rst2html plik.rst plik.html”, aby przekonwertować pojedynczy .rst na HTML. Zainstaluj przez pip install docutils. 
macOS3 apps
TextEdit
Wbudowany Otwórz .rst jako zwykły tekst (użyj Format > Konwertuj na czysty tekst, aby zapobiec konwersji RTF). Brak podglądu.
Visual Studio Code
Darmowy Zainstaluj rozszerzenie „reStructuredText” (lextudio.restructuredtext), aby uzyskać podświetlanie składni i podgląd HTML na żywo przez panel podglądu RST.
Sphinx (sphinx-build)
Open-source Uruchom „sphinx-build -b html docs/ _build/html”, aby wyrenderować pliki .rst do pełnej witryny dokumentacji HTML. Zainstaluj przez pip install sphinx. 
Linux3 apps
Visual Studio Code
Darmowy Zainstaluj rozszerzenie „reStructuredText” (lextudio.restructuredtext), aby uzyskać podświetlanie składni i podgląd HTML na żywo przez panel podglądu RST.
gVim / Vim
Open-source Vim zawiera podświetlanie składni RST; wtyczka rst.vim dodaje zwijanie kodu i podgląd.
Sphinx (sphinx-build)
Open-source Uruchom „sphinx-build -b html docs/ _build/html”, aby wyrenderować pliki .rst do pełnej witryny dokumentacji HTML. Zainstaluj przez pip install sphinx.
Read the Docs
Darmowy Hostuj projekt Sphinx/RST na readthedocs.org, aby wyrenderować go i opublikować jako przeszukiwalną witrynę dokumentacji HTML. Szczegóły techniczne
specyfikacja| Kodowanie | Zwykły tekst, UTF-8 (zgodny z ASCII; pliki Windows mogą zawierać UTF-8 BOM) |
| Nagłówki sekcji | Podkreślenie (i opcjonalnie nadkreślenie) tekstu tytułu znakami =, -, ~, ^ lub innymi znakami interpunkcyjnymi |
| Dyrektywy | Składnia .. nazwa-dyrektywy:: dla bloków kodu, obrazów, notatek, toctree i niestandardowych rozszerzeń |
| Role wewnątrztekstowe | Składnia `:role:` dla semantycznych odsyłaczy, skrótów i matematyki |
| Spis treści | Dyrektywa .. toctree:: (Sphinx) łączy wiele plików .rst w nawigowalne drzewo dokumentów |
| Standardowy procesor | Docutils (rst2html, rst2latex, rst2pdf, rst2xml) |
| Rozszerzenia Sphinx | Sphinx dodaje :ref:, :doc:, autodoc i inne dyrektywy specyficzne dla projektu do rdzenia RST |
| Typ MIME | text/x-rst (de facto); text/prs.fallenstein.rst (zarejestrowany w IANA, rzadko używany) |
| Sygnatura / magic bytes | Brak - plik tekstowy bez nagłówka binarnego |
| Główny ekosystem | Dokumentacja Python (oficjalna dokumentacja Python, NumPy, Django, jądro Linux, Read the Docs) |
| Typowy rozmiar | 1 KB - 500 KB na plik źródłowy; duże projekty Sphinx mogą zawierać setki plików .rst |
| Wydano | 2002 (David Goodger, first release April 2, 2002) |
| Najnowsza wersja | Docutils 0.21 (2024); no separate RST format version number |
| Otwarty standard | Tak · bezpłatny (royalty-free) |
| Specyfikacja | docutils.sourceforge.io |
Konwersje RST
Pytania i odpowiedzi społeczności
pytania użytkownikówBrak pytań - bądź pierwszą osobą, która zapyta o pliki RST.
