Skip to content

Commit 3d8b008

Browse files
committed
Promote underline levels
1 parent 81a8870 commit 3d8b008

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

doc/usage/referencing.rst

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
.. _xref-syntax:
22

3+
========================
34
Cross-referencing syntax
4-
------------------------
5+
========================
56

67
Cross-references are generated by many semantic interpreted text roles.
78
Basically, you only need to write ``:role:`target```, and a link will be
@@ -29,7 +30,7 @@ roles more versatile:
2930
.. _any-role:
3031

3132
Cross-referencing anything
32-
^^^^^^^^^^^^^^^^^^^^^^^^^^
33+
--------------------------
3334

3435
.. rst:role:: any
3536
@@ -70,7 +71,7 @@ Cross-referencing anything
7071
found, all object types of intersphinx inventories are also searched.
7172

7273
Cross-referencing objects
73-
^^^^^^^^^^^^^^^^^^^^^^^^^
74+
-------------------------
7475

7576
These roles are described with their respective domains:
7677

@@ -84,7 +85,7 @@ These roles are described with their respective domains:
8485
.. _ref-role:
8586

8687
Cross-referencing arbitrary locations
87-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
88+
-------------------------------------
8889

8990
.. rst:role:: ref
9091
@@ -139,7 +140,7 @@ Cross-referencing arbitrary locations
139140

140141

141142
Cross-referencing documents
142-
^^^^^^^^^^^^^^^^^^^^^^^^^^^
143+
---------------------------
143144

144145
.. versionadded:: 0.6
145146

@@ -158,7 +159,7 @@ There is also a way to directly link to documents:
158159

159160

160161
Referencing downloadable files
161-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
162+
------------------------------
162163

163164
.. versionadded:: 0.6
164165

@@ -191,7 +192,7 @@ Referencing downloadable files
191192
See :download:`this example script <../example.py>`.
192193

193194
Cross-referencing figures by figure number
194-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
195+
------------------------------------------
195196

196197
.. versionadded:: 1.3
197198

@@ -216,7 +217,7 @@ Cross-referencing figures by figure number
216217
so this role inserts not a reference but the label or the link text.
217218

218219
Cross-referencing other items of interest
219-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
220+
-----------------------------------------
220221

221222
The following roles do possibly create a cross-reference, but do not refer to
222223
objects:

0 commit comments

Comments
 (0)