Roman Bogorodskiy 6bbfa9ac45 Add autosectionlabel_max_depth config option ...

This option defines maximum section depth that labels will be
generated for by the autosectionlabel extension.

This is useful when there are a lot of sections of the similar
structure, for example:

 Releases
 ========
 Release 1
 ---------
 Changes
 ^^^^^^^

 Date
 ^^^^

 ...

 Release N
 ---------
 Changes
 ^^^^^^^

 Date
 ^^^^

This way there'll be warnings about duplicate labels. Setting
autosectionlabel_max_depth allows to skip sections deeper than
'Releases' in the example above.

By default it's None, so things will not change and labels will
be generated for all sections unless configured otherwise.

2017-11-26 18:20:31 +04:00

..

conf.py

Fix #1286, #2099: Add `sphinx.ext.autosectionlabel` extension to allow reference sections using its title

2016-02-14 16:30:57 +09:00

index.rst

Add autosectionlabel_max_depth config option

2017-11-26 18:20:31 +04:00