From 9f3feb6315bdba71a64a0b4f5d6130fd81552a21 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Mon, 11 Feb 2019 18:15:31 +0900 Subject: [PATCH] docs: autosectionlabel_maxdepth --- doc/usage/extensions/autosectionlabel.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/usage/extensions/autosectionlabel.rst b/doc/usage/extensions/autosectionlabel.rst index 20b15ca20..caaa5db26 100644 --- a/doc/usage/extensions/autosectionlabel.rst +++ b/doc/usage/extensions/autosectionlabel.rst @@ -38,3 +38,10 @@ Configuration called ``Introduction`` that appears in document ``index.rst``. Useful for avoiding ambiguity when the same section heading appears in different documents. + +.. confval:: autosectionlabel_maxdepth + + If set, autosectionlabel chooses the sections for labeling by its depth. For + example, when set 1 to ``autosectionlabel_maxdepth``, labels are generated + only for top level sections, and deeper sections are not labeled. It + defaults to ``None`` (disabled).