Sphinx logo

Previous topic

sphinx.ext.extlinks – 外部リンクを短縮表記させるマークアップ

Next topic

sphinx.ext.oldcmarkup 古いC言語向けマークアップとの互換性維持

This Page

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

Module author: Georg Brandl

New in version 1.0.

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

動作させるためには、 'sphinx.ext.viewcode'extensions に追加する必要がありますが、現在はこの拡張はこれ以外の設定値を持ちません。