sphinx.ext.autosectionlabel
– Autoriser les références automatiques aux sections par leurs titres¶
Added in version 1.4.
Cette extension vous permet de référencer les sections par leurs titres. Ceci affecte le rôle de référencement (ref
).
Pas exemple:
A Plain Title
-------------
This is the text of the section.
It refers to the section title, see :ref:`A Plain Title`.
En interne, cette extension génère les étiquettes pour chaque section. Si les mêmes noms de section sont utilisés dans l’ensemble du document, l’un d’entre eux est utilisé comme cible par défaut. La variable de configuration autosectionlabel_prefix_document
peut être utilisée pour rendre uniques les titres apparaissant plusieurs fois mais dans différents documents.
Configuration¶
- autosectionlabel_prefix_document¶
Vrai pour préfixer chaque étiquette de section avec le nom du document qui la contient, suivi de « deux points ». Par exemple,
index:Introduction
pour une section appeléeIntroduction
qui apparaît dans un documentindex.rst
. Utile pour éviter une ambiguïté quand le même titre de section apparaît dans différents documents.
- autosectionlabel_maxdepth¶
Si défini, autosectionlabel choisit les sections à étiqueter par leur profondeur. Par exemple, avec la valeur 1 pour
autosectionlabel_maxdepth
, les étiquettes ne sont générées que pour les sections de premier niveau, et les sections de niveaux inférieurs ne sont pas étiquetés. La valeur par défaut estNone
(désactivé).
Débogage¶
The WARNING: undefined label
indicates that your reference in
ref
is mis-spelled. Invoking sphinx-build with -vvv
(see -v
) will print all section names and the labels that have been
generated for them. This output can help finding the right reference label.