Jak przekonwertować RST na HTML
- Dodaj swój plik .RST - przeciągnij go do powyższego pola lub kliknij, aby przeglądać.
- Przekonwertuj go na format .HTML w kilka sekund.
- Pobierz swój nowy plik .HTML.
Czego się spodziewać
- Dyrektywy specyficzne dla Sphinx (
.. toctree::,:ref:,:doc:) działają tylko wewnątrz pełnego procesu budowania Sphinx; przepuszczenie projektu Sphinx przezrst2htmlspowoduje ich pominięcie lub błędy. - Zarówno
rst2html, jak i Pandoc generują poprawny strukturalnie, ale wizualnie prosty HTML - bez zastosowanego motywu; dodaj własny CSS lub użyj Sphinx, aby uzyskać dopracowany efekt. - Pliki RST mogą zawierać surowy kod HTML i skrypty poprzez
.. raw:: html; konwertuj pliki.rsttylko z zaufanych źródeł.
Najczęściej zadawane pytania
Dlaczego rst2html kończy się błędem w moim projekcie Sphinx?
Plik prawdopodobnie używa dyrektyw dostępnych tylko w Sphinx, takich jak
toctree lub automodule, których Docutils nie potrafi rozwiązać bez pełnego potoku budowania Sphinx. Użyj zamiast tego sphinx-build -b html docs/ _build/html.Które narzędzie generuje najlepiej wyglądający wynik?
Sphinx, ponieważ stosuje kompletny motyw HTML z nawigacją i wyszukiwarką. Wyniki z
rst2html i Pandoc są poprawne, ale wizualnie minimalistyczne.Czy mogę przekonwertować HTML z powrotem na RST?
Nie w sposób w pełni niezawodny - konwersja jest jednostronna. Zachowaj plik
.rst jako źródło prawdy i generuj HTML ponownie po każdej zmianie.Jaka jest różnica między Docutils a Sphinx?
Docutils (
rst2html) przetwarza pojedynczy plik .rst w izolacji. Sphinx bazuje na Docutils i dodaje odniesienia międzyplikowe, spis treści, obsługę rozszerzeń oraz pełne motywy HTML dla kompletnych projektów dokumentacji.
