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

Add docs about :numref: role

Browse Source
This commit is contained in:
tk0miya 2014-10-09 19:31:36 +09:00
parent e32883433a
commit 83e8bbf58b
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/markup/inline.rst
View File

@ -201,6 +201,24 @@ Referencing downloadable files
suitable link generated to it.
Cross-referencing figures by figure number
------------------------------------------
.. versionadded:: 1.3
.. rst:role:: numref
Link to the specified figures, tables and code-blocks; the standard reST
labels are used. When you use this role, it will insert a reference to the
figure with link text by its figure number like "Fig. 1.1".
If an explicit link text is given (like usual: ``:doc:`Image of Sphinx (Fig.
#) <my-figure>```), the link caption will be the title of the reference.
As a special character, `#` will be replaced to figure number.
If :confval:`numfig` is ``False``, figures are not numbered.
so this role inserts not a reference but labels or link text.
Cross-referencing other items of interest
-----------------------------------------