ようこそ!

ユーザの声:

“Cheers for a great tool that actually makes programmers want to write documentation!“

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

このツールはもともと、the Python ドキュメントのために作られました、今では幅広い言語のプロジェクトでドキュメント作成を容易にするツールとして利用されています。もちろん、このサイトもreStructuredText からSphinxで作成されています! 次に特徴を紹介します:

  • 出力形式: HTML (WIndowsのHTMLヘルプを含む)、LaTeX(印刷可能なPDFバージョン)、ePub、Texinfo、man、プレーンテキスト
  • 多岐にわたる相互参照: 意味のマークアップと、関数、クラス、引用、用語解説、似たような情報に対する自動リンク
  • 階層構造: 簡単にドキュメントツリーを定義でき、兄弟、親、子供のドキュメントに対して、リンクを貼れる
  • 自動インデックス作成: 全体インデックスと、言語特有のモジュールインデックス
  • ソースコードの対応: Pygmentsを使った自動ハイライト
  • 拡張: コードスニペットを使った自動テスト, Pythonモジュールのdocstringのインクルード(APIドキュメント作成), 他にもあります
  • 寄贈された拡張: 50以上の拡張が ユーザによって寄贈され。 sphinx-contribリポジトリ内にあり、ほとんどの拡張はPyPIよりインストール可能

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

ドキュメント

SphinxドキュメントのPDFやEPUB版をダウンロードすることもできます: Sphinx が出力した LaTeX から生成したPDF版、並びにEPUB版

サンプル

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

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

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

このドキュメントは日本語に翻訳されています。日本のSphinxユーザグループのみなさん、ありがとう。

Sphinxに関する日本語の本がO'Reillyより出版されました: Sphinxをはじめよう

ホスティング

Sphinxドキュメントをホスティングして欲しい? readthedocs.org はたくさんのSphinxドキュメントをすでにホスティングしています。readthedocsは、ソースコード管理機能や、SphinxのJavaScriptによる検索より強力な検索も提供しています。

コントリビューターガイド

もしあなたがプロジェクトに貢献したい場合、この章はまさにあなたのためのものです。