sphinx.ext.autosectionlabel
--タイトルの参照節の使用が許可されています¶
バージョン 1.4 で追加.
この拡張は、各部分のタイトルを引用することを可能にします。これは参考キャラクターに影響を与えます (ref
)。
例えば:
A Plain Title
-------------
This is the text of the section.
It refers to the section title, see :ref:`A Plain Title`.
内部では,この拡張は部分ごとにラベルを生成する.文書全体で同じ節名が使用されている場合、デフォルトではいずれかをターゲットとして使用する。♪the autosectionlabel_prefix_document
構成変数は、複数回出現するが異なる文書内のタイトルを一意にするために使用することができる。
配置¶
-
autosectionlabel_prefix_document
¶ Trueであれば,節ラベルごとにその存在する文書の名前を付け,コロンを後にする.例えば
index:Introduction
名の上にIntroduction
文書に表示されているindex.rst
それがそうです。同一節の見出しが異なる文書に出現する場合には,曖昧性を回避するのに役立つ
-
autosectionlabel_maxdepth
¶ 設定すると,autosetionLabelは深さごとにラベルを付与する部分を選択する.例えば、1が1に設定されている場合
autosectionlabel_maxdepth
より深い部分にラベルを付加するのではなく、トップ部分のみにラベルを生成する。デフォルト値はNone
(無効化されています)。