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

Promote underline levels

Browse Source
This commit is contained in:
Adam Turner 2023-10-03 19:35:38 +01:00
parent 81a8870eee
commit 3d8b00827e
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/usage/referencing.rst
View File

@ -1,7 +1,8 @@
.. _xref-syntax:
========================
Cross-referencing syntax
------------------------
========================
Cross-references are generated by many semantic interpreted text roles.
Basically, you only need to write ``:role:`target```, and a link will be
@ -29,7 +30,7 @@ roles more versatile:
.. _any-role:
Cross-referencing anything
^^^^^^^^^^^^^^^^^^^^^^^^^^
--------------------------
.. rst:role:: any
@ -70,7 +71,7 @@ Cross-referencing anything
found, all object types of intersphinx inventories are also searched.
Cross-referencing objects
^^^^^^^^^^^^^^^^^^^^^^^^^
-------------------------
These roles are described with their respective domains:
@ -84,7 +85,7 @@ These roles are described with their respective domains:
.. _ref-role:
Cross-referencing arbitrary locations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-------------------------------------
.. rst:role:: ref
@ -139,7 +140,7 @@ Cross-referencing arbitrary locations
Cross-referencing documents
^^^^^^^^^^^^^^^^^^^^^^^^^^^
---------------------------
.. versionadded:: 0.6
@ -158,7 +159,7 @@ There is also a way to directly link to documents:
Referencing downloadable files
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
------------------------------
.. versionadded:: 0.6
@ -191,7 +192,7 @@ Referencing downloadable files
See :download:`this example script <../example.py>`.
Cross-referencing figures by figure number
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
------------------------------------------
.. versionadded:: 1.3
@ -216,7 +217,7 @@ Cross-referencing figures by figure number
so this role inserts not a reference but the label or the link text.
Cross-referencing other items of interest
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-----------------------------------------
The following roles do possibly create a cross-reference, but do not refer to
objects: