RST から HTML への変換方法
- .RST ファイルを追加してください。上のボックスにドロップするか、クリックしてブラウズします。
- 数秒で .HTML に変換されます。
- 新しい .HTML ファイルをダウンロードしてください。
期待される結果
- Sphinx 固有のディレクティブ（
.. toctree::、:ref:、:doc:）は、完全な Sphinx ビルド内でのみ解決されます。Sphinx プロジェクトをrst2htmlで実行すると、これらは暗黙的に削除されるかエラーがスローされます。 rst2htmlと Pandoc はどちらも構造的に正しいものの、視覚的には簡素な HTML を出力します。テーマは適用されません。独自の CSS を追加するか、洗練された結果を得るには Sphinx を使用してください。- RST ファイルは
.. raw:: htmlを介して生の HTML やスクリプトを埋め込むことができます。信頼できるソースからの.rstファイルのみを変換してください。
よくある質問
なぜ Sphinx プロジェクトで rst2html が失敗するのですか？
そのファイルには、完全な Sphinx ビルドパイプラインなしでは Docutils が解決できない
toctree や automodule などの Sphinx 専用ディレクティブが使用されている可能性があります。代わりに sphinx-build -b html docs/ _build/html を実行してください。どのツールが最も見栄えの良い出力を生成しますか？
Sphinx です。ナビゲーションや検索機能を含む完全な HTML テーマが適用されるためです。
rst2html や Pandoc からの出力は正確ですが、視覚的には最小限です。HTML を RST に戻すことはできますか？
確実ではありません。変換は一方向です。
.rst ファイルを信頼できるソースとして保持し、変更があるたびに HTML を再生成してください。Docutils と Sphinx の違いは何ですか？
Docutils (
rst2html) は単一の .rst ファイルを単独で処理します。Sphinx は Docutils をベースに構築されており、ファイル間の相互参照、目次、拡張機能のサポート、および完全なドキュメントプロジェクト用のフル HTML テーマを追加します。
