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

#1236 add note: omit underscore in internal ref

Browse Source
This commit is contained in:
Timotheus Kampik
2017-07-02 15:19:47 +02:00
parent 2d5e05a2ee
commit 328e57949e
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
doc/markup/inline.rst
View File

@@ -145,10 +145,15 @@ Cross-referencing arbitrary locations
The same works for tables that are given an explicit caption using the
:dudir:`table` directive.
* Labels that aren't placed before a section title can still be referenced
to, but you must give the link an explicit title, using this syntax:
* Labels that aren't placed before a section title can still be referenced,
but you must give the link an explicit title, using this syntax:
``:ref:`Link title <label-name>```.
.. note::
Reference labels must start with an underscore. When referencing a
label, the underscore must be omitted (see examples above).
Using :rst:role:`ref` is advised over standard reStructuredText links to
sections (like ```Section title`_``) because it works across files, when
section headings are changed, and for all builders that support