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

Role `numref uses %s as special character instead #` symbol

Browse Source
This commit is contained in:
Takeshi KOMIYA
2015-03-08 07:57:05 +09:00
parent 3d62e353a5
commit 5e48ac9b4f
6 changed files with 15 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/markup/inline.rst
View File

@@ -212,9 +212,9 @@ Cross-referencing figures by figure number
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 an explicit link text is given (like usual: ``:numref:`Image of Sphinx (Fig.
%s) <my-figure>```), the link caption will be the title of the reference.
As a special character, `%s` 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.