Hur man konverterar RST till HTML
- Lägg till din .RST-fil - dra den till rutan ovan eller klicka för att bläddra.
- Konvertera den till .HTML på några sekunder.
- Ladda ner din nya .HTML-fil.
Vad du kan förvänta dig
- Sphinx-specifika direktiv (
.. toctree::,:ref:,:doc:) fungerar endast inuti ett fullständigt Sphinx-bygge; att köra ett Sphinx-projekt genomrst2htmltar tyst bort dem eller kastar fel. - Både
rst2htmloch Pandoc skapar strukturellt korrekt men visuellt enkel HTML - inget tema tillämpas; lägg till din egen CSS eller använd Sphinx för ett polerat resultat. - RST-filer kan bädda in rå HTML och skript via
.. raw:: html; konvertera endast.rst-filer från källor du litar på.
Vanliga frågor
Varför misslyckas rst2html på mitt Sphinx-projekt?
Filen använder sannolikt Sphinx-specifika direktiv som
toctree eller automodule som Docutils inte kan lösa utan Sphinx fullständiga byggprocess. Kör sphinx-build -b html docs/ _build/html istället.Vilket verktyg ger snyggast resultat?
Sphinx, eftersom det tillämpar ett komplett HTML-tema med navigering och sökning. Utdata från
rst2html och Pandoc är korrekt men visuellt minimal.Kan jag konvertera HTML tillbaka till RST?
Inte på ett tillförlitligt sätt - konverteringen är enkelriktad. Behåll
.rst-filen som din primära källa och generera om HTML-filen när den ändras.Vad är skillnaden mellan Docutils och Sphinx?
Docutils (
rst2html) bearbetar en enskild .rst-fil isolerat. Sphinx bygger vidare på Docutils och lägger till korsreferenser mellan filer, innehållsförteckningar, stöd för tillägg och kompletta HTML-teman för hela dokumentationsprojekt.
