sphinx.ext.viewcode --強調表示されたソースコードへのリンクの追加¶
モジュールの作者: Georg Brandl
バージョン 1.0 で追加.
This extension looks at your Python object descriptions (.. class::, ..
function:: etc.) and tries to find the source files where the objects are
contained. When found, a separate HTML page will be output for each module with
a highlighted version of the source code, and a link will be added to all object
descriptions that leads to the source code of the described object. A link back
from the source to the description will also be inserted.
警告
基本的には viewcode Extensionはリンクするモジュールを導入する.いずれのモジュールも導入に副作用があれば，これらのモジュールは以下のように実行される. sphinx-build 走ることです。
スクリプト(ライブラリモジュールとは反対)を記録した場合、メインルーチンが受けることを確認してください if __name__ == '__main__' 条件
また、以下のようにモジュールを導入したくない場合は viewcode ソースコードの位置を教えてください viewcode 使用 viewcode-find-source 事件。
もし viewcode_follow_imported_members また使用する必要があります viewcode-follow-imported 事件。
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_follow_imported_members¶ もしこれが
Trueビューコード拡張が発行されますviewcode-follow-importedイベントは他の拡張解析モジュールの名前である.黙認する.Trueそれがそうです。バージョン 1.3 で追加.
バージョン 1.8 で変更: 名前を立て直す
viewcode_import至るviewcode_follow_imported_membersそれがそうです。
-
viewcode_enable_epub¶ もしこれが
TrueEpubビルダを使用しても、ビュー·コード拡張が有効になります。この拡張はtoctree外部でページを生成するが，epubフォーマットとしては人気がない.1.4.xまで、この拡張は常に有効状態にあります。1.4.xと同じepubを生成するには設定すべきである.
Trueしかし，epubフォーマット検査器のスコアはさらに悪くなる.黙認する.
Falseそれがそうです。バージョン 1.5 で追加.
警告
すべてのepubリーダがビューコード拡張によって生成されたページをサポートしているわけではありません。これらの読者はtoctreeではないページへのリンクを無視している.
一部のリーダーはレンダリング結果が破損しています epubcheck 読者が支持しても、彼の点数はもっと悪くなるだろう。
-
viewcode-find-source(app, modname)¶ バージョン 1.8 で追加.
モジュールのソースコードを調べる.このイベントのイベントハンドラは，ソースコード自体のタプルとトークン辞書を返すべきである.辞書は、クラス、関数、属性などの名前を、そのタイプ、開始行番号、終了行番号のタプルにマッピングします。タイプは、“CLASS”、“DEF”、または“OTHER”のうちの1つでなければなりません。
- パラメータ
app -- Sphinxアプリケーションオブジェクト。
modname -- そのソースコードのモジュールの名前を調べる.
-
viewcode-follow-imported(app, modname, attribute)¶ バージョン 1.8 で追加.
属性の元のモジュールの名前を探す.
- パラメータ
app -- Sphinxアプリケーションオブジェクト。
modname -- 属性が属するモジュールの名前.
attribute -- 追従するメンバーの名前。