Как конвертировать RST в HTML
- Добавьте ваш файл .RST - перетащите его в поле выше или нажмите, чтобы выбрать.
- Конвертируйте его в .HTML за несколько секунд.
- Скачайте ваш новый файл .HTML.
Чего ожидать
- Специфичные для Sphinx директивы (
.. toctree::,:ref:,:doc:) работают только внутри полной сборки Sphinx; запуск проекта Sphinx черезrst2htmlприведет к их потере или ошибкам. - И
rst2html, и Pandoc выдают структурно правильный, но визуально простой HTML без темы оформления; добавьте свой CSS или используйте Sphinx для получения профессионального результата. - Файлы RST могут содержать необработанный HTML и скрипты через
.. raw:: html; конвертируйте файлы.rstтолько из источников, которым вы доверяете.
Часто задаваемые вопросы
Почему rst2html выдает ошибку в моем проекте Sphinx?
Скорее всего, файл использует директивы только для Sphinx, такие как
toctree или automodule, которые Docutils не может обработать без полного конвейера сборки Sphinx. Вместо этого используйте sphinx-build -b html docs/ _build/html.Какой инструмент создает самый красивый результат?
Sphinx, так как он применяет полноценную HTML-тему с навигацией и поиском. Результат работы
rst2html и Pandoc корректен, но визуально минималистичен.Можно ли конвертировать HTML обратно в RST?
Не совсем надежно - конвертация односторонняя. Сохраняйте файл
.rst как основной источник данных и пересоздавайте HTML при любых изменениях.В чем разница между Docutils и Sphinx?
Docutils (
rst2html) обрабатывает один файл .rst изолированно. Sphinx базируется на Docutils и добавляет перекрестные ссылки между файлами, оглавление, поддержку расширений и полные HTML-темы для крупных проектов документации.
