11.. _xref-syntax :
22
3+ ========================
34Cross-referencing syntax
4- ------------------------
5+ ========================
56
67Cross-references are generated by many semantic interpreted text roles.
78Basically, you only need to write ``:role:`target` ``, and a link will be
@@ -29,7 +30,7 @@ roles more versatile:
2930.. _any-role :
3031
3132Cross-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
7273Cross-referencing objects
73- ^^^^^^^^^^^^^^^^^^^^^^^^^
74+ -------------------------
7475
7576These roles are described with their respective domains:
7677
@@ -84,7 +85,7 @@ These roles are described with their respective domains:
8485.. _ref-role :
8586
8687Cross-referencing arbitrary locations
87- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
88+ -------------------------------------
8889
8990.. rst :role :: ref
9091
@@ -139,7 +140,7 @@ Cross-referencing arbitrary locations
139140
140141
141142Cross-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
160161Referencing 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
193194Cross-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
218219Cross-referencing other items of interest
219- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
220+ -----------------------------------------
220221
221222The following roles do possibly create a cross-reference, but do not refer to
222223objects:
0 commit comments