diff --git a/doc/config.rst b/doc/config.rst index 7f1f73186..a3f45abe9 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -297,8 +297,7 @@ General configuration A dictionary mapping ``'figure'``, ``'table'``, ``'code-block'`` and ``'section'`` to strings that are used for format of figure numbers. - As a special character, `%s` and `{number}` will be replaced to figure - number. `{name}` will be replaced to figure caption. + As a special character, `%s` will be replaced to figure number. Default is to use ``'Fig. %s'`` for ``'figure'``, ``'Table %s'`` for ``'table'``, ``'Listing %s'`` for ``'code-block'`` and ``'Section'`` for @@ -306,9 +305,6 @@ General configuration .. versionadded:: 1.3 - .. versionchanged:: 1.5 - Support format of section. Allow to refer the caption of figures. - .. confval:: numfig_secnum_depth The scope of figure numbers, that is, the numfig feature numbers figures diff --git a/doc/markup/inline.rst b/doc/markup/inline.rst index bd02dfa08..a59585bab 100644 --- a/doc/markup/inline.rst +++ b/doc/markup/inline.rst @@ -214,6 +214,7 @@ Cross-referencing figures by figure number .. versionchanged:: 1.5 `numref` role can also refer sections. + And `numref` allows `{name}` for the link text. .. rst:role:: numref @@ -223,7 +224,10 @@ Cross-referencing figures by figure number If an explicit link text is given (like usual: ``:numref:`Image of Sphinx (Fig. %s) ```), the link caption will be the title of the reference. - The format of link text is same as :confval:`numfig_format`. + 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 :confval:`numfig` is ``False``, figures are not numbered. so this role inserts not a reference but labels or link text.