ようこそ!

ユーザの声:

“プログラマーにドキュメントを本当に書きたくさせる、優れたツールを応援しましょう!“

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

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

  • 出力形式: HTML (WIndowsのHTMLヘルプを含む)、LaTeX(印刷可能なPDFバージョン)、ePub、Texinfo、man、プレーンテキスト
  • 多岐にわたる相互参照: 意味のマークアップと、関数、クラス、引用、用語解説、似たような情報に対する自動リンク
  • 階層構造: 簡単にドキュメントツリーを定義でき、兄弟、親、子供のドキュメントに対してリンクが貼れます
  • 自動インデックス作成: 全体インデックスと、言語特有のモジュールインデックス
  • Code handling: automatic highlighting using the Pygments highlighter
  • 拡張: コードスニペットを使った自動テスト, Pythonモジュールのdocstringのインクルード(APIドキュメント作成), 他には
  • Contributed extensions: dozens of extensions contributed by users; most of them installable from PyPI

Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.

ドキュメント

Sphinx ドキュメンテーションのPDF/EPUB 版についても、右下のポップアップメニューからダウンロードすることができます。

サンプル

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

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

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

Transifexに このドキュメントの翻訳チームがあります。Sphinxドキュメントに翻訳者に感謝します。

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

2019年にドイツ語によるSphinx本の第2版が出版されました: Software-Dokumentation mit Sphinx.

ホスティング

Sphinx ドキュメントをホストする場所が必要ですか? readthedocs.org は、すでに多くのSphinx ドキュメントをホストしていて、 プロジェクトのソース管理がうまく統合されています。また、このサイトの特長としては SphinxのJavaScriptベースによるオフライン検索機能を上回る、強力なビルトイン検索を有していることがあります。

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

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

行動規範

我々の行動規範を遵守してください。