IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add debug logging to autosectionlabel (#10881)

Browse Source 
Co-authored-by: Martin Patz <martin@recogni.com>
This commit is contained in:
Martin Patz
2022-10-04 16:25:06 +02:00
committed by GitHub
parent 0a91adb64d
commit 3e29abf8de
3 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
doc/usage/extensions/autosectionlabel.rst
View File

@@ -45,3 +45,12 @@ Configuration
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).
Debugging
---------
The ``WARNING: undefined label`` indicates that your reference in
:rst:role:`ref` is mis-spelled. Invoking :program:`sphinx-build` with ``-vv``
(see :option:`-v`) will print all section names and the labels that have been
generated for them. This output can help finding the right reference label.