Sphinx

•  http://sphinx.pocoo.org/ ( doc : http://sphinx.pocoo.org/contents.html ( rst) / JP  http://sphinx.shibu.jp/ )
•  参考になるドキュメントプロジェクト
  •  Sphinx 本体
    •  doc ディレクトリ
  •  Django Framewordのドキュメント日本語訳
  •  Zope2のドキュメント
  •  Tornado Framework のドキュメント日本語訳
• PDF化
  •  TeXLiveで変換できるっぽいが..
  •  英語プロジェクトでもできなかった
• ノーブレークスペース問題
  • UTF-8のファイルにコピペでもってくると空白がアスキーで0x20ではなく、0xc2 0xa0 （ノーブレークスペース）になることがあるので注意。
  • ノーブレークスペースコードはmake htmlすると に変換されます。
  • sed

    for s in source/*.rst ; do sed -s "s/\xc2\xa0/\x20/g" -i $s ; done
    

Install

•  pip install sphinx
• make latex してPDFにするにはTeXLiveが必要
  • install

    sudo aptitude install texlive-latex-base  texlive-latex-recommended texlive-latex-extra -y 
    

  • 実行 (例)

    make latex
    cd build/latex
    make all-pdf 
    

rst

•  表(グリッドテーブル/シンプルテーブル)
•  リンク `Link text <http://target>!`_

拡張

• rst2pdf でPDF可
• sdedit で UML シーケンス図

:ロール:

• :term:
  • .. glossary: で定義されていない一覧の確認

    $ make html 2>&1 | awk -F: '/glossary/{print $5}' | sort | uniq
    

• :ref:
  •  :ref:で自由な場所にリンクを張る
  • マーク先

    .. _MARKNAME:
    (改行)
    

  • 引用

    :ref:`引用するテキスト <MARKNAME>`
    

Directives

• .. include::
• .. code-block:: python
• .. todo:: , .. todos::
  • conf.py でtodo_include_todos = True しないと表示されない。

---

• TeXLive,rst