sphinx.ext.viewcode – ハイライト済みのソースコードへのリンクを追加

モジュールの作者: Georg Brandl

バージョン 1.0 で追加.

この拡張は、Pythonのオブジェクト説明(.. class::, .. function:: など)、そのオブジェクトが含まれるソースコードを探しに行きます。もし見つかれば、それぞれのモジュールごとにハイライトされたソースコードのHTMLページを出力し、すべての説明オブジェクトからのリンクが追加されます。これにより、説明オブジェクトのソースコードを見に行くことができます。また、説明オブジェクトへの逆リンクも挿入されます。

This extension works only on HTML related builders like html, applehelp, devhelp, htmlhelp, qthelp and so on except singlehtml. By default epub builder doesn’t support this extension (see viewcode_enable_epub).

この拡張機能によって以下の設定値が追加されます:

viewcode_import

これに ``True``が設定されている場合、viewcode エクステンションは他のモジュールによってインポートされる関数、クラス、属性などのエイリアスオブジェクトを追跡します。副作用としてこのオプションが指定されない場合、何も起こりません。規定値は``True``です。

警告

viewcode_import imports the modules to be followed real location. If any modules have side effects on import, these will be executed by viewcode when sphinx-build is run.

もしあなたが (ライブラリモジュールではなく) スクリプトをドキュメント化したいのであれば、スクリプトのメインルーチンが if __name__ == '__main__' 条件により保護されていることを確認して下さい。

バージョン 1.3 で追加.

viewcode_enable_epub

If this is True, viewcode extension is also enabled even if you use epub builders. This extension generates pages outside toctree, but this is not preferred as epub format.

Until 1.4.x, this extension is always enabled. If you want to generate epub as same as 1.4.x, you should set True, but epub format checker’s score becomes worse.

デフォルト値は False です。

バージョン 1.5 で追加.

警告

Not all epub readers support pages generated by viewcode extension. These readers ignore links to pages are not under toctree.

Some reader’s rendering result are corrupted and epubcheck‘s score becomes worse even if the reader supports.