ローカルPC上のAPIドキュメントをBlender自身から開く[Obsolute]

対応バージョン

実行形式

Note

(確認は2.69上)

スタートアップファイルを変更

Blender Python API をローカル環境でも読めるようにする

ローカルPC上のAPIドキュメントをBlender自身から開く

注意:スタートアップファイルを編集する際には慎重に作業してください。Blenderが正しく動かなくなる可能性もあります。また、バージョンアップ時に変更した部分を反映させるためにファイル上書き、ということは絶対にしないでください。

今回はBlenderのAPIドキュメントをオフラインで確認したい場合に、Blenderのヘルプメニューからローカル上にあるドキュメントをWebブラウザで開くメニューを追加する、というある意味設定変更のようなことを行います。

これを行うとネットにつながっていない状態でもAPIドキュメントを開けるわけです。あら便利。

APIドキュメントを配置する

まずはAPIドキュメントをダウンロードしましょう。以下のURLを開きます。

http://www.blender.org/documentation/250PythonDoc/

最新ドキュメントのページにリダイレクトされます。そのページの"A compressed ZIP file of this site is available"のリンクから、ZIPファイルをダウンロードし、適当に展開します。ここでは、 C:\blender270api\に展開したものとして、またBlender本体はC:\blenderにあるものとして説明します。

所定の場所に変換したら、contents.html を開きます。ブラウザが開くよう関連付けられているのであれば、Webブラウザが開いてページを表示します。ブラウザのアドレスバーのURLをコピーしておきましょう。

file:///C:/blender270api/contents.html

Blenderのヘルプメニューの定義場所を探す

Blender 2.69がC:\blender に配置されていた場合、 C:\blender\2.69\scripts\startup\bl_ui\space_info.py 内にその定義が INFO_MT_help クラスにあります。

class INFO_MT_help(Menu):

bl_label = "Help"

def draw(self, context):

layout = self.layout

layout.operator("wm.url_open", text="Manual", icon='HELP').url = "http://wiki.blender.org/index.php/Doc:2.6/Manual"

layout.operator("wm.url_open", text="Release Log", icon='URL').url = "http://www.blender.org/development/release-logs/blender-269"

layout.separator()

layout.operator("wm.url_open", text="Blender Website", icon='URL').url = "http://www.blender.org"

layout.operator("wm.url_open", text="Blender e-Shop", icon='URL').url = "http://www.blender.org/e-shop"

layout.operator("wm.url_open", text="Developer Community", icon='URL').url = "http://www.blender.org/community/get-involved"

layout.operator("wm.url_open", text="User Community", icon='URL').url = "http://www.blender.org/community/user-community"

layout.separator()

layout.operator("wm.url_open", text="Report a Bug", icon='URL').url = "http://projects.blender.org/tracker/?atid=498&group_id=9&func=browse"

layout.separator()

layout.operator("wm.url_open", text="Python API Reference", icon='URL').url = bpy.types.WM_OT_doc_view._prefix

layout.operator("wm.operator_cheat_sheet", icon='TEXT')

layout.operator("wm.sysinfo", icon='TEXT')

layout.separator()

layout.operator("anim.update_data_paths", text="FCurve/Driver Version fix", icon='HELP')

layout.operator("logic.texface_convert", text="TexFace to Material Convert", icon='GAME')

layout.separator()

layout.operator("wm.splash", icon='BLENDER')

space_info.pyの編集

あらかじめspace_info.pyのバックアップコピーをとっておいて、space_info.pyを編集します。

space_info.pyを編集します。先ほどメモっておいたURLを指定するだけですね。

編集前:

layout.operator("wm.url_open", text="Python API Reference", icon='URL').url = bpy.types.WM_OT_doc_view._prefix

layout.operator("wm.operator_cheat_sheet", icon='TEXT')

編集後(赤字が追加したところ):

layout.operator("wm.url_open", text="Python API Reference", icon='URL').url = bpy.types.WM_OT_doc_view._prefix

layout.operator("wm.url_open", text="Python API Reference(offline)", icon='URL').url = "file:///C:/blender270api/contents.html"

layout.operator("wm.operator_cheat_sheet", icon='TEXT')

編集が終わったらspace_info.pyを保存します。

Blenderを起動します。

HELPメニューに、"Python API Reference(offline)"というメニューが追加されていること、選択するとローカルディスク上のAPIドキュメントがWebブラウザで開くことを確認します。