Sphinx

Kick4Wiki

Sphinx †

• Sphinxドキュメント

使い方 †

• reStructuredText入門 ― Sphinx v1.1 (hg) documentation
• Sphinxマークアップ集 ― Sphinx v1.1 (hg) documentation
• Alabaster: a Sphinx theme — Alabaster documentation

• Sphinxクックブック
• ドキュメントを作りたくなってしまう魔法のツール Sphinx
• Sphinx拡張 ― Sphinx v1.1 (hg) documentation
• SphinxでPDFファイル作成 :: ドキュメンテーションツール スフィンクス Sphinx-users.jp

おもしろそうな拡張機能 †

• sdedit
• blockdiag
• docx

インストール †

• debian
  • aptitude install python-sphinx だと、 sphinx-0.4.2-1がインストールされるようだ。

• easy_install
  • easy_installをインストール（Windows） - yummy-yummy
  • Python Package Index : setuptools 0.6c11
  • 結局、setuptools-0.6c11-py2.5.eggというのをインストールしたら、easy_installも入っていた。
  • easy_install Sphinx-1.0.5-py2.5.egg でインストール
  • python 2.4〜2.7で動くようだ。

sphinxドキュメントの作り方 †

$ sphinx-quickstart

graphviz拡張 †

conf.pyの extensionsに'sphinx.ext.graphviz'を追加

例

.. graphviz::

 digraph foo {
   rankdir = LR;
   node[shape="circle",fontname="Helvetica",fontsize=14];
   edge[fontname="Helvetica"];

   "初期\n状態" -> bar;
   bar -> baz [label = "ss(b)"];
   foo -> bar;
   baz -> foo;
 }