ようこそ!

ユーザの声:

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

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

このツールはもともと���新しいPythonのドキュメントの変換のために作られました。Pythonのプロジェクトのためのすばらしい機能を提供してきましたが、現在ではC/C++も既にサポートしています。また、他の言語に対するサポート機能も現在計画中です。もちろん、このホームページもまた、reStructuredTextのソースで作成され、Sphinxを使って作られています!

Sphinxは開発途上です。現在提供されている機能は次の通りです。これらはきちんと動作していて、“実際に”Pythonのドキュメントサイトで見ることができます:

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

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

ドキュメント

Sphinx最初の一歩 基本的なタスクの概要紹介 目次 すべてのドキュメントはこちら

検索ページ ドキュメントの検索 全体インデックス すべての関数、クラス、用語

サンプル

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

サンプルのドキュメントのソースを見たければ、このトップページ以外のすべてのドキュメントのページにある、 “Show source(ソースを表示)”のリンクをクリックしてみてください。

また、matplotlibの開発者によって書かれた、Sphinxを使ったカスタマイズされたドキュメントの作り方に関する チュートリアルにも興味を持つでしょう。

Sphinxのインストール

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

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

翻訳

間違いを見つけたら？

このドキュメントの翻訳は渋川よしき(@shibukawa)が行っています。日本語上のバグを発見した方は、本家ではなく、 Bitbucket上の翻訳リポジトリのチケットに登録、もしくはyoshiki@shibu.jpまでご連絡ください。

翻訳協力

Sphinxを紹介してくれたり、一部翻訳を手伝ってくれたり、間違いの指摘などをしてくださった方々です。もし抜け漏れがあればご連絡ください。

• Voluntas
• 清水川さん
• 及川(@renoiv)さん
• 小松さん