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

Merge pull request #3905 from TimKam/1236-add-note-referencing-arbitrary-locations

Browse Source 
#1236 add note: omit underscore in internal ref
This commit is contained in:
Takeshi KOMIYA 2017-07-15 22:37:51 +09:00 committed by GitHub
commit d59fdda8c9
1 changed files with 7 additions and 2 deletions
Show Stats 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 The same works for tables that are given an explicit caption using the
:dudir:`table` directive. :dudir:`table` directive.
* Labels that aren't placed before a section title can still be referenced * 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: but you must give the link an explicit title, using this syntax:
``:ref:`Link title <label-name>```. ``: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 Using :rst:role:`ref` is advised over standard reStructuredText links to
sections (like ```Section title`_``) because it works across files, when sections (like ```Section title`_``) because it works across files, when
section headings are changed, and for all builders that support section headings are changed, and for all builders that support