トピックへSphinxドキュメント次のトピックへSphinxのインストールこのページソースコードを表示クイック検索イントロダクション¶これはSphinxドキュメンテーションビルダーのドキュメントです。(以下reST)のソースファイルを様々な出力形式に変換したり、クロスリファレンスやインデックスなどを自動生成するツールです。reSTフォーマットのドキュメント群を含むディレクトリを用意すれば、Sphinxはブラウザでの閲覧が容易でナビゲーションがある構造がしっかりしたHTMLファイル群を生成することができます。ソースがサブディレクトリに分かれていても問題はありません。それだけではなく、同じソースファイルから、LaTeXを用いてPDFファイルも生成することができます。このドキュメントでは、自動生成のAPIのドキュメントではなく、手で作成するドキュメンテーションにフォーカスします。こちらもreSTを解釈することができます。他のシステムからの変換¶このセクションでは、他のドキュメントシステムからreStructuredText/Sphinxへの移行を考えている人達へのヒントを集めています。FlanaganはHTMLからreSTに変換するスクリプトを作成してきました。見つけることができます。reSTに変換できます。WojdyrはDocbookをreST+Sphinxマークアップに変換するスクリプトを作成しました。