注意

このドキュメントは0.6.4当時のドキュメントを翻訳したものです。最新のドキュメントはSphinx-Users.jp を確認してください。

ようこそ!

ユーザの声:

“このような、プログラマーがドキュメントを書きたくなってしまうすばらしいツールに乾杯！”

Sphinxは知的で美しいドキュメントを簡単に作れるようにするツールです。Georg Brandlによって開発され、BSDライセンスのもとで公開されています。

このツールはもともと、新しいPythonのドキュメントの変換のために作られました。そして、今までに数々のPythonや、他の言語で開発されているプロジェクトに対して、すばらしいドキュメンテーションのサポートを行ってきました。もちろん、このホームページもまた、reStructuredTextのソースで作成され、Sphinxを使って作られています!

このプログラムはまだ開発途上ですが、以下のような機能がすでに提供されています。これらはきちんと動作していて、“実際に”Pythonのドキュメントサイトで見ることができます:

• 出力フォーマット: HTML(Windows HTMLヘルプも含む)とLaTeX, 印刷可能なPDF
• 広範囲にわたるクロスリファレンス: 意味のマークアップと、関数、クラス、用語解説、似たような情報
• 階層構造: 簡単にドキュメントツリーを定義でき、兄弟、親、子供のドキュメントに対して、リンクを貼れる
• 自動インデックス作成: 全体インデックスと、モジュールインデックス
• ソースコードの対応: Pygmentsを使った自動ハイライト
• 拡張: コードスニペットを使った自動テスト, Pythonモジュールのdocstringのインクルードなど

SphinxはreStructuredTextをマークアップ言語として使用しています。Sphinxの強さの多くの部分はreStructuredTextと、そのパース、変換プログラム群である、Docutilsからきています。

サンプルドキュメント

Pythonドキュメントとこのページは、それぞれSphinxのサンプルとなっています。PDFバージョンのSphinxドキュメントもダウンロードすることができます。これはSphinxが生成したLaTeXから作成されたものです。

サンプルのドキュメントのSphinxのソースファイルは、このトップページ以外のすべてのドキュメントに張られている“Show source”のリンクをたどると見ることができます。

Sphinxを使って生成されたドキュメントをもっと見たい場合には、Sphinxを利用しているプロジェクトのページで見ることができます。

ドキュメント

目次 すべてのドキュメントはこちら 検索ページ ドキュメントの検索

全体インデックス すべての関数、クラス、用語 モジュールインデックス 全てのドキュメント付きのモジュール一覧

Sphinxのインストール

SphinxはPython Package Indexにて、easy-installを使用してインストール可能なパッケージで提供されています。

ソースコードはhttp://bitbucket.org/birkenfeld/sphinx/にて、Mercurialのリポジトリで見ることができます。

翻訳

このドキュメントの翻訳は渋川よしきが行っています。日本語上のバグを発見した方は、本家ではなく、 yoshiki@shibu.jpまでご連絡ください。