sphinx

pythonベースのドキュメント整形言語。とでも言えばいいのか。

• 公式
  • http://sphinx.pocoo.org/
  • http://sphinx-users.jp/
• 翻訳文書
  • http://sphinx.shibu.jp/
• Windowsで開始
  • http://sphinx-users.jp/gettingstarted/install_windows.html
    • 割と書いてある通り。Python 2.7.2でも順当に動く。
  • “make html”とだけ書いたバッチファイル作って楽しよう。
  • _build/htmlの中身にショートカット作って楽しよう。
  • バージョン管理はsubverionとかgitとかMercurialとか？
    • 例 : http://togakushi.bitbucket.org/bitbucket.html
• 描画補助
  • Sphinxは、何故か文字列こねくり回してダイアグラム書いちゃおうぜ、なノリが実装されてる。
  • まずは試してみる
    • http://interactive.blockdiag.com/
  • いろいろ書いてある
    • http://docs.ssm.myz.info/yakumo3/index.html
  • blockdiag
    • http://blockdiag.com/blockdiag-ja/build/html/index.html
    • ブロックダイアグラム生成ツール。
      • 単品で使う
        • easyinstall blockdiag * sphinxと組み合わせて使う * easyinstall sphinxcontrib-blockdiag
        • conf.pyに追記
        • <code> extensions = ['sphinxcontrib.blockdiag'] blockdiagfontpath = 'C:\windows\fonts\meiryo.ttf'</code> * windowsで使用する場合は、今でも問題が起きるかもしれない。 * http://99blues.dyndns.org/blog/2011/01/blockdiag_for_win/ * 文字の折り返しってどうやるんだろう。 * 文字量に応じてサイズを可変にするのってどうやるんだろう。 * seqdiag * シーケンス図生成ツール * actdiag * 業務フロー生成ツール * nwdiag * ネットワーク図生成ツール * graphviz * 単品でも割と有名なダイアグラム生成ツール * DOT言語使うアレ * とても参考になる * http://yutuki.blogspot.jp/2012/01/sphinxhtmlpdf.html