summaryrefslogtreecommitdiff
path: root/doc/markup
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2016-09-17 14:58:43 +0900
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2016-09-17 15:51:18 +0900
commit2b10fc0188cd9339381328ddbc9c1a1386794df7 (patch)
tree5b6f36d09101a662f625332a6e0ebbb80bc21f00 /doc/markup
parent1aafc7e2e5bd9d6127f364d0a65b13342e0a1c98 (diff)
downloadsphinx-git-2b10fc0188cd9339381328ddbc9c1a1386794df7.tar.gz
Fix #2916: `numref` role can also refer caption as an its linktext
Diffstat (limited to 'doc/markup')
-rw-r--r--doc/markup/inline.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/markup/inline.rst b/doc/markup/inline.rst
index 300416356..bd02dfa08 100644
--- a/doc/markup/inline.rst
+++ b/doc/markup/inline.rst
@@ -213,7 +213,7 @@ Cross-referencing figures by figure number
.. versionadded:: 1.3
.. versionchanged:: 1.5
- `numref` role can also refer sections
+ `numref` role can also refer sections.
.. rst:role:: numref
@@ -223,7 +223,7 @@ Cross-referencing figures by 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.
+ The format of link text is same as :confval:`numfig_format`.
If :confval:`numfig` is ``False``, figures are not numbered.
so this role inserts not a reference but labels or link text.