Skip to content

Commit 283d863

Browse files
timhoffmAA-Turner
andauthored
Minor cleanup to autosectionlabel docs (#12992)
Co-authored-by: Adam Turner <[email protected]>
1 parent 566d1cd commit 283d863

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

doc/usage/extensions/autosectionlabel.rst

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
.. highlight:: rst
22

3-
:mod:`sphinx.ext.autosectionlabel` -- Allow reference sections using its title
4-
==============================================================================
3+
:mod:`sphinx.ext.autosectionlabel` -- Allow referencing sections by their title
4+
===============================================================================
55

66
.. module:: sphinx.ext.autosectionlabel
7-
:synopsis: Allow reference section its title.
7+
:synopsis: Allow referencing sections by their title.
88

99
.. versionadded:: 1.4
1010

11-
This extension allows you to refer sections its title. This affects to the
12-
reference role (:rst:role:`ref`).
11+
By default, cross-references to sections use labels (see :rst:role:`ref`).
12+
This extension allows you to instead refer to sections by their title.
1313

1414
For example::
1515

@@ -32,6 +32,8 @@ Configuration
3232
-------------
3333

3434
.. confval:: autosectionlabel_prefix_document
35+
:type: :code-py:`bool`
36+
:default: :code-py:`False`
3537

3638
True to prefix each section label with the name of the document it is in,
3739
followed by a colon. For example, ``index:Introduction`` for a section
@@ -40,11 +42,13 @@ Configuration
4042
documents.
4143

4244
.. confval:: autosectionlabel_maxdepth
45+
:type: :code-py:`int | None`
46+
:default: :code-py:`None`
4347

4448
If set, autosectionlabel chooses the sections for labeling by its depth. For
4549
example, when set 1 to ``autosectionlabel_maxdepth``, labels are generated
4650
only for top level sections, and deeper sections are not labeled. It
47-
defaults to ``None`` (disabled).
51+
defaults to ``None`` (i.e. all sections are labeled).
4852

4953

5054
Debugging

0 commit comments

Comments
 (0)