2010年4月22日木曜日

sphinx-buildを試してみた。

最近のblender2.52の開発版ではpythonのドキュメントを自動的に作成する
為の仕組みに対応しているそうでbpyとかのリファレンスドキュメントを
ソースコードから生成できるらしい。

FreeStyle統合版もその仕組みを利用してスタイルモジュールのリファレンスを
自動的に出力できるようになったそうなので早速試してみた。


上記のリンク先のFreeStyle統合版の公式ブログでも触れられているように
sphinxというpythonのプログラムを使用するらしい。
基本的な手順はblenderの公式wikiにまとめられているのでそちらを参照して
作業を進めていけばOKなはず。

ただし自分の環境では幾つか上記の手順通りには行かなかったのでメモ。

まずは、最初にblenderで実行するsphinx_doc_gen.pyが公式wikiの場所でなく
./source/blender/python/doc/sphinx_doc_gen.py
にあるのでその辺は読み替えてすすめる。

あとsphinxをインストールする際に
easy_install -U Sphinx
とした場合、異なるバージョンのpythonのsitepackageにインストールされてしまう
ことがあるので「今使っているpythonのバージョン」を確認しておく方が良さげ。

この手順で使用するblender、python、sphinx、どれもpython31である必要がある
っぽいんだけどOSXはデフォルトでpythonがインストールされているおかげで
何がどのバージョンで、いまどれが使用されているのかよくわかってないところが
あったのでかなり戸惑った。

portでpython関連をごにょごにょいじってたら気づいたらできるようになってたという
感じなのでちょっと後味が悪いというか、未だに良くわかってない。orz。
LuxRenderの話になるけどこの辺をちゃんとできればluxblend25で必要なpylux.soの
ビルドもうまく行くんだろうけど・・・。

とりあえずhtml版のリファレンスドキュメントの生成は成功したようなのでzipで固めた
ものをこちらにアップしてみました。展開後のフォルダの中のcontents.htmlが目次です。
FreeStyleのスタイルモジュール以外にもbpyのリファレンスもまるごと全部入ってます。

開発版のソース(svn28296)を元に生成されたリファレンスなので、内容はもちろん
暫定的なものですが、FreeStyle公式ページのドキュメントが幾分現状に比べて古く
なっているので目を通しておいて損はないかと。




---------------------------------------------------------------
コメントなどありましたらこちらへ->web拍手