summaryrefslogtreecommitdiff
path: root/doc/markup
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2018-01-08 20:19:36 +0900
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2018-01-08 20:19:36 +0900
commit326d7e64cedb5280a9cf51a90c00266e1dab9e7b (patch)
tree0ce4e7845e09aa822da027fbe6401174458c47d9 /doc/markup
parent7a194f52960fe5ace04ef7daa72563e6d3bf094f (diff)
parent3965b1f023bbac932d0dfbf414386f0667ec002a (diff)
downloadsphinx-git-326d7e64cedb5280a9cf51a90c00266e1dab9e7b.tar.gz
Merge branch 'master' into dont_emit_system_message_on_autodoc_warning
Diffstat (limited to 'doc/markup')
-rw-r--r--doc/markup/inline.rst18
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/markup/inline.rst b/doc/markup/inline.rst
index 32360baf7..4d14a653d 100644
--- a/doc/markup/inline.rst
+++ b/doc/markup/inline.rst
@@ -63,7 +63,7 @@ Cross-referencing anything
by :rst:role:`doc`, :rst:role:`ref` or :rst:role:`option`.
Custom objects added to the standard domain by extensions (see
- :meth:`.add_object_type`) are also searched.
+ :meth:`Sphinx.add_object_type`) are also searched.
* Then, it looks for objects (targets) in all loaded domains. It is up to
the domains how specific a match must be. For example, in the Python
@@ -227,15 +227,15 @@ Cross-referencing figures by figure number
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: ``:numref:`Image of Sphinx (Fig.
- %s) <my-figure>```), the link caption will be the title of the reference.
- As a special character, `%s` and `{number}` will be replaced to figure
- number. `{name}` will be replaced to figure caption.
- If no explicit link text is given, the value of :confval:`numfig_format` is
- used to default value of link text.
+ If an explicit link text is given (as usual: ``:numref:`Image of Sphinx (Fig.
+ %s) <my-figure>```), the link caption will serve as title of the reference.
+ As placeholders, `%s` and `{number}` get replaced by the figure
+ number and `{name}` by the figure caption.
+ If no explicit link text is given, the :confval:`numfig_format` setting is
+ used as fall-back default.
- If :confval:`numfig` is ``False``, figures are not numbered.
- so this role inserts not a reference but labels or link text.
+ If :confval:`numfig` is ``False``, figures are not numbered,
+ so this role inserts not a reference but the label or the link text.
Cross-referencing other items of interest
-----------------------------------------